تكر يهدف إلى تلبية احتياجات المستخدمين في [وصف المجال الذي يستهدفه التطبيق]. يوفر التطبيق مجموعة من الميزات والخدمات المفيدة التي تساعد المستخدمين على القيام بمهامهم بكل سهولة وفاعلية.
\",\n \"image\": \"http://beeb.test/storage/images/pages/1.png\"\n }\n}" } ] }, { "name": "Terms", "description": "## Purpose\nTerms & conditions.\n\n## Figma screen\n\n- **Screen:** Terms & conditions\n- **Feature ID:** `R-AUTH-03`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_CLIENT_FILE/BEEB-Rider-App)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/client/terms", "host": [ "{{base_url}}" ], "path": [ "client", "terms" ] }, "description": "## Purpose\nTerms & conditions.\n\n## Figma screen\n\n- **Screen:** Terms & conditions\n- **Feature ID:** `R-AUTH-03`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_CLIENT_FILE/BEEB-Rider-App)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/client/terms", "host": [ "{{base_url}}" ], "path": [ "client", "terms" ] }, "description": "## Purpose\nTerms & conditions.\n\n## Figma screen\n\n- **Screen:** Terms & conditions\n- **Feature ID:** `R-AUTH-03`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_CLIENT_FILE/BEEB-Rider-App)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": {\n \"content\": \"شروط وأحكام الاستخدام\\r\\n\\r\\n شكرًا لاستخدامك لتطبيق [اسم التطبيق]. يرجى قراءة هذه الشروط والأحكام بعناية قبل استخدام التطبيق. يعتبر استخدامك للتطبيق تأكيدًا منك على قبول هذه الشروط والأحكام والالتزام بها بشكل كامل. إذا كنت لا توافق على هذه الشروط والأحكام، يرجى عدم استخدام التطبيق.\\r\\n \\r\\n الملكية الفكرية: \\r\\n أنت توافق على أن جميع حقوق الملكية الفكرية المتعلقة بتطبيق [اسم التطبيق] ومحتواه (بما في ذلك العلامات التجارية، والشعارات، والنصوص، والصور، والرسومات، والأيقونات، والبرمجيات، والمحتوى الصوتي والبصري الآخر) تعود إلى المطور أو الجهة المملوكة لهذه الحقوق. يُحظر نسخ، توزيع، نقل، عرض عام، بيع، أو استخدام أي من هذه العناصر بأي طريقة تنتهك حقوق الملكية الفكرية للمطور.\\r\\n \\r\\n الاستخدام الشخصي: \\r\\n يتم توفير التطبيق للاستخدام الشخصي فقط. يجب عليك استخدام التطبيق وفقًا للقوانين واللوائح المعمول بها ولأغراض قانونية فقط. يُحظر استخدام التطبيق بطرق تنتهك حقوق الملكية الفكرية للآخرين أو تسبب ضررًا للمطور أو أي طرف آخر.\\r\\n \\r\\n المحتوى المستخدم: \\r\\n عند استخدام التطبيق، قد يطلب منك تقديم بعض المعلومات الشخصية. يجب عليك التأكد من أن المعلومات التي تقدمها صحيحة ومحدّثة. يحظر استخدام معلومات المستخدمين الآخرين بأي طريقة تنتهك خصوصيتهم أو حقوقهم.\\r\\n \\r\\n التحديثات والتعديلات: \\r\\n قد يتم تحديث التطبيق وإجراء تعديلات عليه من وقت لآخر. يجوز للمطور تحديث الشروط والأحكام دون إشعار مسبق. ينبغي عليك مراجعة هذه الشروط والأحكام بشكل منتظم للتأكد من التزامك بها الحالية.\\r\\n \\r\\n الضمان والمسؤولية : \\r\\n يقدم التطبيق \\\"كما هو\\\" دون أي ضمانات صريحة أو ضمنية. يُحظر على المطور أو أي طرف آخر يشارك في إنشاء أو توفير التطبيق أن يكونواستمرارًا في الشروط والأحكام: \\r\\n \\r\\n ويُحظر على المطور أو أي طرف آخر يشارك في إنشاء أو توفير التطبيق أن يكونوا مسؤولين عن أي ضرر مباشر أو غير مباشر ينتج عن استخدامك للتطبيق أو عدم قدرتك على استخدامه، بما في ذلك ولكن لا يقتصر على الأضرار المادية وفقدان البيانات والانقطاع عن الخدمة.\\r\\n \\r\\n ربط المواقع الخارجية: \\r\\n قد يحتوي التطبيق على روابط إلى مواقع الويب الخارجية التي لا تخضع للسيطرة المطور. لا يتحمل المطور مسؤولية المحتوى أو الأداء أو الأمان أو سياسات الخصوصية لتلك المواقع الخارجية. ينبغي عليك أخذ الحيطة والحذر عند الانتقال إلى مواقع الويب الخارجية عن طريق الروابط المقدمة في التطبيق.\\r\\n \\r\\n إنهاء الاستخدام: \\r\\n يحتفظ المطور بحق إنهاء استخدامك للتطبيق في أي وقت وبأي سبب دون إشعار مسبق. قد يتضمن ذلك إنهاء الوصول إلى حسابك وحذف بياناتك المخزنة في التطبيق.\\r\\n \\r\\n التعديلات على الشروط والأحكام: \\r\\n يحتفظ المطور بحق تعديل هذه الشروط والأحكام في أي وقت. ينبغي عليك مراجعة هذه الشروط والأحكام بشكل دوري للتأكد من التزامك بها الحالية.\\r\\n \\r\\n الاتصال: \\r\\n إذا كان لديك أي أسئلة أو استفسارات حول الشروط والأحكام، يرجى الاتصال بنا عبر [ذكر وسيلة الاتصال مثل البريد الإلكتروني أو الهاتف].\\r\\n \\r\\n يرجى ملاحظة أن هذه الشروط والأحكام تعتبر نسخة مترجمة للمساعدة في توفير المعلومات باللغة العربية. ومع ذلك، إذا وجد تباين بين النسخة العربية والنسخة الإنجليزية، يعتبر النص الإنجليزي الأصلي لهذه الشروط والأحكام هو النص الساري والملزم.\",\n \"image\": \"http://beeb.test/storage/images/pages/2.png\"\n }\n}" } ] }, { "name": "Privacy", "description": "## Purpose\nPrivacy policy.\n\n## Figma screen\n\n- **Screen:** Privacy policy\n- **Feature ID:** `R-AUTH-03`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_CLIENT_FILE/BEEB-Rider-App)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/client/privacy", "host": [ "{{base_url}}" ], "path": [ "client", "privacy" ] }, "description": "## Purpose\nPrivacy policy.\n\n## Figma screen\n\n- **Screen:** Privacy policy\n- **Feature ID:** `R-AUTH-03`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_CLIENT_FILE/BEEB-Rider-App)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/client/privacy", "host": [ "{{base_url}}" ], "path": [ "client", "privacy" ] }, "description": "## Purpose\nPrivacy policy.\n\n## Figma screen\n\n- **Screen:** Privacy policy\n- **Feature ID:** `R-AUTH-03`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_CLIENT_FILE/BEEB-Rider-App)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": {\n \"content\": \"نحن في [اسم الشركة/التطبيق] نولي أهمية كبيرة لحماية خصوصية المستخدمين لدينا. تحترم هذه السياسة خصوصيتك وتشرح كيفية جمعنا واستخدامنا وحمايتنا للمعلومات التي تقدمها عند استخدام التطبيق. يرجى قراءة هذه السياسة بعناية لفهم ممارساتنا فيما يتعلق بالبيانات الشخصية وكيفية معالجتها. باستخدام التطبيق، فإنك توافق على جمع واستخدام وكشف المعلومات الشخصية وفقًا لهذه السياسة.\\r\\n\\r\\n المعلومات التي نجمعها: \\r\\n عند استخدام التطبيق، قد نقوم بجمع بعض المعلومات الشخصية التي تقدمها بشكل طوعي، مثل الاسم وعنوان البريد الإلكتروني ومعلومات الاتصال الأخرى. قد نقوم أيضًا بتسجيل معلومات غير شخصية، مثل نوع المتصفح ونظام التشغيل وتفاصيل الجهاز، بهدف تحسين خدمتنا وتجربتك.\\r\\n \\r\\n استخدام المعلومات: \\r\\n نستخدم المعلومات التي نجمعها لتخصيص وتحسين تجربتك في التطبيق، وتوفير المحتوى والخدمات المناسبة لك، والتواصل معك بشأن التحديثات والمستجدات، وتحسين خدماتنا وتطويرها، وتوفير الدعم الفني عند الحاجة.\\r\\n \\r\\n حماية المعلومات: \\r\\n نحمي المعلومات الشخصية التي نجمعها من خلال إجراءات أمنية ملائمة للحفاظ على سرية وسلامة البيانات. نحن نتبع معايير الصناعة المعترف بها لحماية المعلومات، ولكن يجب ملاحظة أنه لا يوجد نظام أمان مطلق. لذا، فإننا لا نضمن بشكل صريح أو ضمني سرية المعلومات المرسلة إلينا.\\r\\n \\r\\n مشاركة المعلومات: \\r\\n نحن لا نبيع أو نؤجر أو نتاجر بأي طريقة معلوماتك الشخصية لأطراف ثالثة. قد نقوم بمشاركة بعض المعلومات مع جهات خارجية معتمدة عند الحاجة، مثل مقدمي الخدمات الفنية والشركاء التجاريين، ولكن ذلك يتم وفقًا للقوانين السارية وبما يتوافق مع هذه السياسة.\\r\\n \\r\\n روابط إلى مواقع خارجية: \\r\\n قد يحتستمر السياسة في شرح العديد من النقاط الأخرى المتعلقة بالمعلومات الشخصية والتعامل معها، مثل استخدام ملفات تعريف الارتباط (الكوكيز)، وحقوق الدخول والتصحيح والحذف للمعلومات الشخصية، وحماية الأطفال عبر الإنترنت، وتغييرات في سياسة الخصوصية، والاتصال بنا لأية استفسارات أو مخاوف تتعلق بالخصوصية.\\r\\n \\r\\n يرجى ملاحظة أن هذه النسخة الملخصة لسياسة الخصوصية وتهدف إلى توفير نظرة عامة فقط. إذا كنت ترغب في مزيد من التفاصيل والمعلومات، يرجى الرجوع إلى النسخة الكاملة لسياسة الخصوصية المتاحة في التطبيق أو على موقعنا الإلكتروني.\\r\\n \\r\\n نحن نتعهد بالامتثال لمبادئ حماية الخصوصية وتنظيمات البيانات ذات الصلة في البلدان التي نعمل بها. نحرص على الحفاظ على سرية وأمان المعلومات الشخصية التي تثق بنا إياها.\\r\\n \\r\\n تأكيدًا للتزامنا بحماية الخصوصية، فإن استخدامك المستمر للتطبيق يعتبر موافقة منك على سياسة الخصوصية هذه. إذا كنت لا توافق على أي جزء من هذه السياسة، فيرجى التوقف عن استخدام التطبيق وحذفه من جهازك.\\r\\n \\r\\n تاريخ السريان: [تحديد تاريخ السريان لسياسة الخصوصية]\\r\\n \\r\\n \",\n \"image\": \"http://beeb.test/storage/images/pages/3.png\"\n }\n}" } ] }, { "name": "Social links", "description": "## Purpose\nSocial media URLs.\n\n## Figma screen\n\n- **Screen:** Social links\n- **Feature ID:** `R-ACC-09`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_CLIENT_FILE/BEEB-Rider-App)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/client/socials", "host": [ "{{base_url}}" ], "path": [ "client", "socials" ] }, "description": "## Purpose\nSocial media URLs.\n\n## Figma screen\n\n- **Screen:** Social links\n- **Feature ID:** `R-ACC-09`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_CLIENT_FILE/BEEB-Rider-App)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/client/socials", "host": [ "{{base_url}}" ], "path": [ "client", "socials" ] }, "description": "## Purpose\nSocial media URLs.\n\n## Figma screen\n\n- **Screen:** Social links\n- **Feature ID:** `R-ACC-09`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_CLIENT_FILE/BEEB-Rider-App)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": [\n {\n \"link\": \"https://www.facebook.com\",\n \"name\": \"facebook\",\n \"icon\": \"http://beeb.test/storage/images/socials/default.png\"\n },\n {\n \"link\": \"https://www.instgram.com\",\n \"name\": \"instgram\",\n \"icon\": \"http://beeb.test/storage/images/socials/default.png\"\n },\n {\n \"link\": \"https://www.whatsapp.com\",\n \"name\": \"whatsapp\",\n \"icon\": \"http://beeb.test/storage/images/socials/default.png\"\n }\n ]\n}" } ] } ] } ] }, { "name": "Provider", "description": "Investor API — `/api/provider/*`\n\n## Screen map (`ai helper/provider/`)\n\n| Postman folder | Figma / PNG | Feature |\n|----------------|-------------|---------|\n| 00 Platform | `provider-login.png` (brand panel stats) | I-AUTH-01 |\n| 01 Onboarding | `provider-register step 1/2.png`, `provider-login.png` | I-AUTH-01, I-AUTH-02, I-AUTH-03 |\n| 02 Forgot Password | `provider-change password.png` | I-AUTH-04 |\n| 03 Profile | `provider-update profile.png` | I-ACC |\n| 04 Notifications | (dashboard header) | I-NOTIF |\n| 05 Phone update | profile flow | I-ACC-04 |\n| 07 Dashboard | `provider-home statistics.png`, `provider-vehicles.png`, `provider-profit statistiscs.png` | I-HOME, I-VEH, I-EARN |\n| 06 Support & complaints | — | I-ACC |\n| 08 Settlements | — (I-FIN screens) | I-FIN-01–03 |\n\nAuth is **email + password** only (no `verify-login` for provider).", "item": [ { "name": "00 — Platform", "description": "Public endpoint — no auth required. Feeds the **login page brand panel** stats (`I-AUTH-01`).\n\nRoute: `GET /api/provider/stats`", "item": [ { "name": "Platform stats", "description": "## Purpose\n**I-AUTH-01** — Live stats shown in the login page right-panel **before** the investor logs in.\n\nReturns platform-wide totals: completed rides today, investor profit-share % (from settings), active vehicles count. No token required.\n\n## Figma screen\n\n- **Screen:** Login — brand panel stats\n- **Feature ID:** `I-AUTH-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-login.png`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n }\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/stats", "host": [ "{{base_url}}" ], "path": [ "provider", "stats" ] }, "description": "## Purpose\n**I-AUTH-01** — Live stats shown in the login page right-panel **before** the investor logs in.\n\nReturns platform-wide totals: completed rides today, investor profit-share % (from settings), active vehicles count. No token required.\n\n## Figma screen\n\n- **Screen:** Login — brand panel stats\n- **Feature ID:** `I-AUTH-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-login.png`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n }\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/stats", "host": [ "{{base_url}}" ], "path": [ "provider", "stats" ] }, "description": "## Purpose\n**I-AUTH-01** — Live stats shown in the login page right-panel **before** the investor logs in.\n\nReturns platform-wide totals: completed rides today, investor profit-share % (from settings), active vehicles count. No token required.\n\n## Figma screen\n\n- **Screen:** Login — brand panel stats\n- **Feature ID:** `I-AUTH-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-login.png`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n }\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n }\n}" } ] } ] }, { "name": "01 — Onboarding & Auth", "description": "Investor signup and session (`I-AUTH`).\n\n## Recommended test order\n1. **Register** — multipart KYC → `is_approved: null` (no token). Screen: `provider-register step 1/2.png`.\n2. Approve investor in **Admin** → `/admin/providers`.\n3. **Login** — `email` + `password` → saves `{{provider_token}}`. Screen: `provider-login.png`.\n4. **Get profile** and other authenticated folders.\n\n**Seeded login:** `{{provider_email}}` / `{{provider_password}}` (after `migrate:fresh --seed`).\n\n**Forgot password OTP:**\n```sql\nSELECT code FROM auth_otps WHERE otpable_type LIKE '%Provider%' ORDER BY id DESC LIMIT 1;\n```\nSet `{{otp_code}}` before check-code / reset.", "item": [ { "name": "Register (KYC)", "description": "## Purpose\n**I-AUTH-02 / I-AUTH-03** — one multipart request (UI may show two steps). Creates investor with `is_approved: null`; **no token**. Upload any number of `documents[]` files (1–10, no type labels); response `data.documents` is a URL array in upload order.\n\n## Figma screen\n\n- **Screen:** Sign-up steps 1–2 (basic data + KYC)\n- **Feature ID:** `I-AUTH-02`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-register step 1 .png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `first_name` | string | yes | `Ahmed` | Step 1 — first name |\n| `last_name` | string | yes | `Al-Otaibi` | Step 1 — last name |\n| `email` | string | yes | `{{provider_register_email}}` | Login email (unique) |\n| `country_code` | string | yes | `966` | Dial code |\n| `phone` | string | yes | `{{provider_register_phone}}` | Saudi mobile (starts with 5) |\n| `password` | string | yes | `TestPass123!` | Min 8 chars |\n| `password_confirmation` | string | yes | `TestPass123!` | Must match |\n| `national_id` | string | yes | `1023456789` | 10 digits |\n| `iban` | string | yes | `SA0380000000608010167519` | SA + 22 digits |\n| `vehicle_count` | string | yes | `3-5` | 1-2 | 3-5 | 6-10 | 10+ |\n| `documents[]` | file | yes | `` | Attachment (repeat row for more files, max 10 total) |\n| `terms_accepted` | string | yes | `1` | 1 or true |\n\n## Notes\n## Postman\n1. Body → **form-data** (not raw JSON).\n2. Set `provider_register_email` / `provider_register_phone` to unique values.\n3. Add one or more `documents[]` rows (type **File**) — no document type needed.\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"new.investor@example.com\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": null,\n \"is_verified\": false,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": false,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 0,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n## Example request\n```json\n{\n \"first_name\": \"Ahmed\",\n \"last_name\": \"Al-Otaibi\",\n \"email\": \"{{provider_register_email}}\",\n \"country_code\": \"{{provider_country_code}}\",\n \"phone\": \"{{provider_register_phone}}\",\n \"password\": \"{{provider_password}}\",\n \"password_confirmation\": \"{{provider_password}}\",\n \"national_id\": \"1023456789\",\n \"iban\": \"SA0380000000608010167519\",\n \"vehicle_count\": \"3-5\",\n \"documents[]\": \"(file)\",\n \"terms_accepted\": \"1\"\n}\n```\n\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/register", "host": [ "{{base_url}}" ], "path": [ "provider", "register" ] }, "description": "## Purpose\n**I-AUTH-02 / I-AUTH-03** — one multipart request (UI may show two steps). Creates investor with `is_approved: null`; **no token**. Upload any number of `documents[]` files (1–10, no type labels); response `data.documents` is a URL array in upload order.\n\n## Figma screen\n\n- **Screen:** Sign-up steps 1–2 (basic data + KYC)\n- **Feature ID:** `I-AUTH-02`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-register step 1 .png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `first_name` | string | yes | `Ahmed` | Step 1 — first name |\n| `last_name` | string | yes | `Al-Otaibi` | Step 1 — last name |\n| `email` | string | yes | `{{provider_register_email}}` | Login email (unique) |\n| `country_code` | string | yes | `966` | Dial code |\n| `phone` | string | yes | `{{provider_register_phone}}` | Saudi mobile (starts with 5) |\n| `password` | string | yes | `TestPass123!` | Min 8 chars |\n| `password_confirmation` | string | yes | `TestPass123!` | Must match |\n| `national_id` | string | yes | `1023456789` | 10 digits |\n| `iban` | string | yes | `SA0380000000608010167519` | SA + 22 digits |\n| `vehicle_count` | string | yes | `3-5` | 1-2 | 3-5 | 6-10 | 10+ |\n| `documents[]` | file | yes | `` | Attachment (repeat row for more files, max 10 total) |\n| `terms_accepted` | string | yes | `1` | 1 or true |\n\n## Notes\n## Postman\n1. Body → **form-data** (not raw JSON).\n2. Set `provider_register_email` / `provider_register_phone` to unique values.\n3. Add one or more `documents[]` rows (type **File**) — no document type needed.\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"new.investor@example.com\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": null,\n \"is_verified\": false,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": false,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 0,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n## Example request\n```json\n{\n \"first_name\": \"Ahmed\",\n \"last_name\": \"Al-Otaibi\",\n \"email\": \"{{provider_register_email}}\",\n \"country_code\": \"{{provider_country_code}}\",\n \"phone\": \"{{provider_register_phone}}\",\n \"password\": \"{{provider_password}}\",\n \"password_confirmation\": \"{{provider_password}}\",\n \"national_id\": \"1023456789\",\n \"iban\": \"SA0380000000608010167519\",\n \"vehicle_count\": \"3-5\",\n \"documents[]\": \"(file)\",\n \"terms_accepted\": \"1\"\n}\n```\n\n", "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "description": "First name (step 1)", "type": "text", "disabled": false, "value": "Ahmed" }, { "key": "last_name", "description": "Last name (step 1)", "type": "text", "disabled": false, "value": "Al-Otaibi" }, { "key": "email", "description": "Unique login email", "type": "text", "disabled": false, "value": "{{provider_register_email}}" }, { "key": "country_code", "description": "Dial code", "type": "text", "disabled": false, "value": "{{provider_country_code}}" }, { "key": "phone", "description": "Unique Saudi mobile (starts with 5)", "type": "text", "disabled": false, "value": "{{provider_register_phone}}" }, { "key": "password", "description": "Min 8 characters", "type": "text", "disabled": false, "value": "{{provider_password}}" }, { "key": "password_confirmation", "description": "Must match password", "type": "text", "disabled": false, "value": "{{provider_password}}" }, { "key": "national_id", "description": "10 digits, starts with 1 or 2", "type": "text", "disabled": false, "value": "1023456789" }, { "key": "iban", "description": "SA + 22 digits", "type": "text", "disabled": false, "value": "SA0380000000608010167519" }, { "key": "vehicle_count", "description": "1-2 | 3-5 | 6-10 | 10+", "type": "text", "disabled": false, "value": "3-5" }, { "key": "documents[]", "description": "Attachment — PDF/JPG/PNG ≤10MB (duplicate row for more, max 10)", "type": "file", "disabled": false, "value": "" }, { "key": "terms_accepted", "description": "1 or true", "type": "text", "disabled": false, "value": "1" } ] } }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/register", "host": [ "{{base_url}}" ], "path": [ "provider", "register" ] }, "description": "## Purpose\n**I-AUTH-02 / I-AUTH-03** — one multipart request (UI may show two steps). Creates investor with `is_approved: null`; **no token**. Upload any number of `documents[]` files (1–10, no type labels); response `data.documents` is a URL array in upload order.\n\n## Figma screen\n\n- **Screen:** Sign-up steps 1–2 (basic data + KYC)\n- **Feature ID:** `I-AUTH-02`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-register step 1 .png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `first_name` | string | yes | `Ahmed` | Step 1 — first name |\n| `last_name` | string | yes | `Al-Otaibi` | Step 1 — last name |\n| `email` | string | yes | `{{provider_register_email}}` | Login email (unique) |\n| `country_code` | string | yes | `966` | Dial code |\n| `phone` | string | yes | `{{provider_register_phone}}` | Saudi mobile (starts with 5) |\n| `password` | string | yes | `TestPass123!` | Min 8 chars |\n| `password_confirmation` | string | yes | `TestPass123!` | Must match |\n| `national_id` | string | yes | `1023456789` | 10 digits |\n| `iban` | string | yes | `SA0380000000608010167519` | SA + 22 digits |\n| `vehicle_count` | string | yes | `3-5` | 1-2 | 3-5 | 6-10 | 10+ |\n| `documents[]` | file | yes | `` | Attachment (repeat row for more files, max 10 total) |\n| `terms_accepted` | string | yes | `1` | 1 or true |\n\n## Notes\n## Postman\n1. Body → **form-data** (not raw JSON).\n2. Set `provider_register_email` / `provider_register_phone` to unique values.\n3. Add one or more `documents[]` rows (type **File**) — no document type needed.\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"new.investor@example.com\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": null,\n \"is_verified\": false,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": false,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 0,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n## Example request\n```json\n{\n \"first_name\": \"Ahmed\",\n \"last_name\": \"Al-Otaibi\",\n \"email\": \"{{provider_register_email}}\",\n \"country_code\": \"{{provider_country_code}}\",\n \"phone\": \"{{provider_register_phone}}\",\n \"password\": \"{{provider_password}}\",\n \"password_confirmation\": \"{{provider_password}}\",\n \"national_id\": \"1023456789\",\n \"iban\": \"SA0380000000608010167519\",\n \"vehicle_count\": \"3-5\",\n \"documents[]\": \"(file)\",\n \"terms_accepted\": \"1\"\n}\n```\n\n", "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "description": "First name (step 1)", "type": "text", "disabled": false, "value": "Ahmed" }, { "key": "last_name", "description": "Last name (step 1)", "type": "text", "disabled": false, "value": "Al-Otaibi" }, { "key": "email", "description": "Unique login email", "type": "text", "disabled": false, "value": "{{provider_register_email}}" }, { "key": "country_code", "description": "Dial code", "type": "text", "disabled": false, "value": "{{provider_country_code}}" }, { "key": "phone", "description": "Unique Saudi mobile (starts with 5)", "type": "text", "disabled": false, "value": "{{provider_register_phone}}" }, { "key": "password", "description": "Min 8 characters", "type": "text", "disabled": false, "value": "{{provider_password}}" }, { "key": "password_confirmation", "description": "Must match password", "type": "text", "disabled": false, "value": "{{provider_password}}" }, { "key": "national_id", "description": "10 digits, starts with 1 or 2", "type": "text", "disabled": false, "value": "1023456789" }, { "key": "iban", "description": "SA + 22 digits", "type": "text", "disabled": false, "value": "SA0380000000608010167519" }, { "key": "vehicle_count", "description": "1-2 | 3-5 | 6-10 | 10+", "type": "text", "disabled": false, "value": "3-5" }, { "key": "documents[]", "description": "Attachment — PDF/JPG/PNG ≤10MB (duplicate row for more, max 10)", "type": "file", "disabled": false, "value": "" }, { "key": "terms_accepted", "description": "1 or true", "type": "text", "disabled": false, "value": "1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": null,\n \"is_verified\": false,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": false,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 0,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "const json = pm.response.json();", "const pick = (obj, path) => path.split(\".\").reduce((o, k) => (o == null ? undefined : o[k]), obj);", "const __provider_register_email = pick(json, 'data.email');", "if (__provider_register_email !== undefined && __provider_register_email !== null && __provider_register_email !== '') {", " pm.collectionVariables.set('provider_register_email', String(__provider_register_email));", " console.log('Saved provider_register_email');", "}", "const __provider_phone = pick(json, 'data.phone');", "if (__provider_phone !== undefined && __provider_phone !== null && __provider_phone !== '') {", " pm.collectionVariables.set('provider_phone', String(__provider_phone));", " console.log('Saved provider_phone');", "}", "const __provider_country_code = pick(json, 'data.country_code');", "if (__provider_country_code !== undefined && __provider_country_code !== null && __provider_country_code !== '') {", " pm.collectionVariables.set('provider_country_code', String(__provider_country_code));", " console.log('Saved provider_country_code');", "}" ] } } ] }, { "name": "Login", "description": "## Purpose\n**I-AUTH-01** — email + password. Returns `data.token` when `is_approved` is true. Pending review → `needApproval`. Wrong credentials → `fail`.\n\n## Figma screen\n\n- **Screen:** Login (email + password)\n- **Feature ID:** `I-AUTH-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-login.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | Registered email |\n| `password` | string | yes | `{{provider_password}}` | Account password |\n| `device_type` | string | yes | `web` | ios | android | web |\n| `device_id` | string | no | `postman-provider-1` | Optional |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\",\n \"password\": \"{{provider_password}}\",\n \"device_type\": \"web\",\n \"device_id\": \"postman-provider-1\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/login", "host": [ "{{base_url}}" ], "path": [ "provider", "login" ] }, "description": "## Purpose\n**I-AUTH-01** — email + password. Returns `data.token` when `is_approved` is true. Pending review → `needApproval`. Wrong credentials → `fail`.\n\n## Figma screen\n\n- **Screen:** Login (email + password)\n- **Feature ID:** `I-AUTH-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-login.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | Registered email |\n| `password` | string | yes | `{{provider_password}}` | Account password |\n| `device_type` | string | yes | `web` | ios | android | web |\n| `device_id` | string | no | `postman-provider-1` | Optional |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\",\n \"password\": \"{{provider_password}}\",\n \"device_type\": \"web\",\n \"device_id\": \"postman-provider-1\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"email\": \"{{provider_email}}\",\n \"password\": \"{{provider_password}}\",\n \"device_type\": \"web\",\n \"device_id\": \"postman-provider-1\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Live 200", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/login", "host": [ "{{base_url}}" ], "path": [ "provider", "login" ] }, "description": "## Purpose\n**I-AUTH-01** — email + password. Returns `data.token` when `is_approved` is true. Pending review → `needApproval`. Wrong credentials → `fail`.\n\n## Figma screen\n\n- **Screen:** Login (email + password)\n- **Feature ID:** `I-AUTH-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-login.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | Registered email |\n| `password` | string | yes | `{{provider_password}}` | Account password |\n| `device_type` | string | yes | `web` | ios | android | web |\n| `device_id` | string | no | `postman-provider-1` | Optional |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\",\n \"password\": \"{{provider_password}}\",\n \"device_type\": \"web\",\n \"device_id\": \"postman-provider-1\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"email\": \"{{provider_email}}\",\n \"password\": \"{{provider_password}}\",\n \"device_type\": \"web\",\n \"device_id\": \"postman-provider-1\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"needVerification\",\n \"msg\": \"تم ارسال كود التأكيد الى رقم الهاتف\",\n \"data\": {\n \"id\": 1,\n \"clinic_name_translated\": \"استثمار أحمد\",\n \"clinic_name\": {\n \"ar\": \"استثمار أحمد\",\n \"en\": \"Ahmed Investment\"\n },\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"license_image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"owner\": {\n \"name\": \"Ahmed Al-Otaibi\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\"\n },\n \"location\": {\n \"address\": \"King Fahd Road, Riyadh\",\n \"lat\": 24.7136,\n \"lng\": 46.6753,\n \"map_desc\": \"Riyadh, King Fahd Road\",\n \"city\": {\n \"id\": 1,\n \"name\": \"الرياض\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n }\n },\n \"contact\": {\n \"phone\": \"512345678\",\n \"whatsapp\": \"512345678\",\n \"email\": \"ahmed.investor@beeb.test\"\n },\n \"bank\": {\n \"name\": \"Al Rajhi Bank\",\n \"account_name\": \"Ahmed Al-Otaibi\",\n \"account_num\": \"512345678\",\n \"iban\": \"SA0380000000608010167519\"\n },\n \"category\": null,\n \"token\": \"\",\n \"is_approved\": 1,\n \"rejection_reason\": null,\n \"no_vehicles\": true,\n \"is_notify\": true\n }\n}" } ] }, { "name": "Logout", "description": "## Purpose\nRevoke current Sanctum token.\n\n## Figma screen\n\n- **Screen:** Dashboard — logout\n- **Feature ID:** `I-AUTH-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/logout", "host": [ "{{base_url}}" ], "path": [ "provider", "logout" ] }, "description": "## Purpose\nRevoke current Sanctum token.\n\n## Figma screen\n\n- **Screen:** Dashboard — logout\n- **Feature ID:** `I-AUTH-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/logout", "host": [ "{{base_url}}" ], "path": [ "provider", "logout" ] }, "description": "## Purpose\nRevoke current Sanctum token.\n\n## Figma screen\n\n- **Screen:** Dashboard — logout\n- **Feature ID:** `I-AUTH-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"يرجى اعادة تسجيل الدخول\"\n}" } ] }, { "name": "Delete account", "description": "## Purpose\nSoft-delete authenticated provider.\n\n## Figma screen\n\n- **Screen:** Account — delete\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n", "request": { "method": "DELETE", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/delete-account", "host": [ "{{base_url}}" ], "path": [ "provider", "delete-account" ] }, "description": "## Purpose\nSoft-delete authenticated provider.\n\n## Figma screen\n\n- **Screen:** Account — delete\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/delete-account", "host": [ "{{base_url}}" ], "path": [ "provider", "delete-account" ] }, "description": "## Purpose\nSoft-delete authenticated provider.\n\n## Figma screen\n\n- **Screen:** Account — delete\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}" } ] } ] }, { "name": "02 — Forgot Password", "description": "**I-AUTH-04** — email OTP reset (`provider-change password.png`).\n\nAfter provider forgot-password, set `otp_code` from: `SELECT code FROM auth_otps WHERE otpable_type LIKE '%Provider%' ORDER BY id DESC LIMIT 1`", "item": [ { "name": "Send reset code", "description": "## Purpose\nSend OTP to the email on file.\n\n## Figma screen\n\n- **Screen:** Forgot password\n- **Feature ID:** `I-AUTH-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | Registered email |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\"\n}\n```\n\n## Notes\nAfter provider forgot-password, set `otp_code` from: `SELECT code FROM auth_otps WHERE otpable_type LIKE '%Provider%' ORDER BY id DESC LIMIT 1`\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": null,\n \"is_verified\": false,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": false,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 0,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"123456\",\n \"token\": \"\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/password/forget", "host": [ "{{base_url}}" ], "path": [ "provider", "password", "forget" ] }, "description": "## Purpose\nSend OTP to the email on file.\n\n## Figma screen\n\n- **Screen:** Forgot password\n- **Feature ID:** `I-AUTH-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | Registered email |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\"\n}\n```\n\n## Notes\nAfter provider forgot-password, set `otp_code` from: `SELECT code FROM auth_otps WHERE otpable_type LIKE '%Provider%' ORDER BY id DESC LIMIT 1`\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": null,\n \"is_verified\": false,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": false,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 0,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"123456\",\n \"token\": \"\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"email\": \"{{provider_email}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Live 200", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/password/forget", "host": [ "{{base_url}}" ], "path": [ "provider", "password", "forget" ] }, "description": "## Purpose\nSend OTP to the email on file.\n\n## Figma screen\n\n- **Screen:** Forgot password\n- **Feature ID:** `I-AUTH-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | Registered email |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\"\n}\n```\n\n## Notes\nAfter provider forgot-password, set `otp_code` from: `SELECT code FROM auth_otps WHERE otpable_type LIKE '%Provider%' ORDER BY id DESC LIMIT 1`\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": null,\n \"is_verified\": false,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": false,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 0,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"123456\",\n \"token\": \"\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"email\": \"{{provider_email}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Target class [App\\\\Http\\\\Controllers\\\\Api\\\\Provider\\\\ForgetPasswordController] does not exist.\"\n}" } ] }, { "name": "Check reset code", "description": "## Purpose\nValidate OTP before setting a new password.\n\n## Figma screen\n\n- **Screen:** Forgot password — OTP\n- **Feature ID:** `I-AUTH-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | |\n| `code` | string | yes | `{{otp_code}}` | 6-digit OTP |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\",\n \"code\": \"{{otp_code}}\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/password/check-code", "host": [ "{{base_url}}" ], "path": [ "provider", "password", "check-code" ] }, "description": "## Purpose\nValidate OTP before setting a new password.\n\n## Figma screen\n\n- **Screen:** Forgot password — OTP\n- **Feature ID:** `I-AUTH-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | |\n| `code` | string | yes | `{{otp_code}}` | 6-digit OTP |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\",\n \"code\": \"{{otp_code}}\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"email\": \"{{provider_email}}\",\n \"code\": \"{{otp_code}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Live 200", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/password/check-code", "host": [ "{{base_url}}" ], "path": [ "provider", "password", "check-code" ] }, "description": "## Purpose\nValidate OTP before setting a new password.\n\n## Figma screen\n\n- **Screen:** Forgot password — OTP\n- **Feature ID:** `I-AUTH-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | |\n| `code` | string | yes | `{{otp_code}}` | 6-digit OTP |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\",\n \"code\": \"{{otp_code}}\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"email\": \"{{provider_email}}\",\n \"code\": \"{{otp_code}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Target class [App\\\\Http\\\\Controllers\\\\Api\\\\Provider\\\\ForgetPasswordController] does not exist.\"\n}" } ] }, { "name": "Reset password", "description": "## Purpose\nSet new password after OTP validation.\n\n## Figma screen\n\n- **Screen:** Reset password\n- **Feature ID:** `I-AUTH-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | |\n| `code` | string | yes | `{{otp_code}}` | |\n| `password` | string | yes | `NewPass123!` | Min 8, letters+numbers |\n| `password_confirmation` | string | yes | `NewPass123!` | Must match |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\",\n \"code\": \"{{otp_code}}\",\n \"password\": \"NewPass123!\",\n \"password_confirmation\": \"NewPass123!\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/password/reset", "host": [ "{{base_url}}" ], "path": [ "provider", "password", "reset" ] }, "description": "## Purpose\nSet new password after OTP validation.\n\n## Figma screen\n\n- **Screen:** Reset password\n- **Feature ID:** `I-AUTH-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | |\n| `code` | string | yes | `{{otp_code}}` | |\n| `password` | string | yes | `NewPass123!` | Min 8, letters+numbers |\n| `password_confirmation` | string | yes | `NewPass123!` | Must match |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\",\n \"code\": \"{{otp_code}}\",\n \"password\": \"NewPass123!\",\n \"password_confirmation\": \"NewPass123!\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"email\": \"{{provider_email}}\",\n \"code\": \"{{otp_code}}\",\n \"password\": \"NewPass123!\",\n \"password_confirmation\": \"NewPass123!\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Live 200", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/password/reset", "host": [ "{{base_url}}" ], "path": [ "provider", "password", "reset" ] }, "description": "## Purpose\nSet new password after OTP validation.\n\n## Figma screen\n\n- **Screen:** Reset password\n- **Feature ID:** `I-AUTH-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nNone\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `email` | string | yes | `{{provider_email}}` | |\n| `code` | string | yes | `{{otp_code}}` | |\n| `password` | string | yes | `NewPass123!` | Min 8, letters+numbers |\n| `password_confirmation` | string | yes | `NewPass123!` | Must match |\n\n## Example request\n```json\n{\n \"email\": \"{{provider_email}}\",\n \"code\": \"{{otp_code}}\",\n \"password\": \"NewPass123!\",\n \"password_confirmation\": \"NewPass123!\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"email\": \"{{provider_email}}\",\n \"code\": \"{{otp_code}}\",\n \"password\": \"NewPass123!\",\n \"password_confirmation\": \"NewPass123!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Target class [App\\\\Http\\\\Controllers\\\\Api\\\\Provider\\\\ForgetPasswordController] does not exist.\"\n}" } ] } ] }, { "name": "03 — Profile", "description": "**I-ACC** — investor profile (`provider-update profile.png`). Requires `{{provider_token}}`.", "item": [ { "name": "Get profile", "description": "## Purpose\nProfile card: `investor_since`, `profit_rate`, `vehicle_count`, masked `national_id` / `iban`, `iban_full` (owner only), `has_pending_profile_update`, `documents`, `dashboard_preview`.\n\n## Figma screen\n\n- **Screen:** Profile\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-update profile.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/profile", "host": [ "{{base_url}}" ], "path": [ "provider", "profile" ] }, "description": "## Purpose\nProfile card: `investor_since`, `profit_rate`, `vehicle_count`, masked `national_id` / `iban`, `iban_full` (owner only), `has_pending_profile_update`, `documents`, `dashboard_preview`.\n\n## Figma screen\n\n- **Screen:** Profile\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-update profile.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/profile", "host": [ "{{base_url}}" ], "path": [ "provider", "profile" ] }, "description": "## Purpose\nProfile card: `investor_since`, `profit_rate`, `vehicle_count`, masked `national_id` / `iban`, `iban_full` (owner only), `has_pending_profile_update`, `documents`, `dashboard_preview`.\n\n## Figma screen\n\n- **Screen:** Profile\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-update profile.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"يرجى اعادة تسجيل الدخول\"\n}" } ] }, { "name": "Update profile", "description": "## Purpose\n**I-ACC-02** — Update investor profile. `name` saves immediately. Changes to `email`, `phone`, `country_code`, `iban`, or `national_id` create an admin review request (`has_pending_profile_update`). Send `phone` + `country_code` together.\n\n## Figma screen\n\n- **Screen:** Update profile\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-update profile.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `name` | string | yes | `Ahmed Al-Otaibi` | Full name |\n| `email` | string | no | `ahmed.investor@beeb.test` | Triggers admin review when changed |\n| `country_code` | string | no | `966` | Required with `phone` |\n| `phone` | string | no | `512345678` | Saudi mobile (9–10 digits, starts with 5) |\n| `iban` | string | no | `SA0380000000608010167519` | SA + 22 digits |\n| `national_id` | string | no | `1023456789` | 10 digits, starts with 1 or 2 |\n| `vehicle_count` | string | no | `3-5` | 1-2 | 3-5 | 6-10 | 10+ |\n| `image` | file | no | `` | Avatar (JPG/PNG max 2MB) |\n\n## Example request\n```json\n{\n \"name\": \"Ahmed Al-Otaibi\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"iban\": \"SA0380000000608010167519\",\n \"national_id\": \"1023456789\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/update/profile", "host": [ "{{base_url}}" ], "path": [ "provider", "update", "profile" ] }, "description": "## Purpose\n**I-ACC-02** — Update investor profile. `name` saves immediately. Changes to `email`, `phone`, `country_code`, `iban`, or `national_id` create an admin review request (`has_pending_profile_update`). Send `phone` + `country_code` together.\n\n## Figma screen\n\n- **Screen:** Update profile\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-update profile.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `name` | string | yes | `Ahmed Al-Otaibi` | Full name |\n| `email` | string | no | `ahmed.investor@beeb.test` | Triggers admin review when changed |\n| `country_code` | string | no | `966` | Required with `phone` |\n| `phone` | string | no | `512345678` | Saudi mobile (9–10 digits, starts with 5) |\n| `iban` | string | no | `SA0380000000608010167519` | SA + 22 digits |\n| `national_id` | string | no | `1023456789` | 10 digits, starts with 1 or 2 |\n| `vehicle_count` | string | no | `3-5` | 1-2 | 3-5 | 6-10 | 10+ |\n| `image` | file | no | `` | Avatar (JPG/PNG max 2MB) |\n\n## Example request\n```json\n{\n \"name\": \"Ahmed Al-Otaibi\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"iban\": \"SA0380000000608010167519\",\n \"national_id\": \"1023456789\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Al-Otaibi\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"iban\": \"SA0380000000608010167519\",\n \"national_id\": \"1023456789\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Live 200", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/update/profile", "host": [ "{{base_url}}" ], "path": [ "provider", "update", "profile" ] }, "description": "## Purpose\n**I-ACC-02** — Update investor profile. `name` saves immediately. Changes to `email`, `phone`, `country_code`, `iban`, or `national_id` create an admin review request (`has_pending_profile_update`). Send `phone` + `country_code` together.\n\n## Figma screen\n\n- **Screen:** Update profile\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-update profile.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `name` | string | yes | `Ahmed Al-Otaibi` | Full name |\n| `email` | string | no | `ahmed.investor@beeb.test` | Triggers admin review when changed |\n| `country_code` | string | no | `966` | Required with `phone` |\n| `phone` | string | no | `512345678` | Saudi mobile (9–10 digits, starts with 5) |\n| `iban` | string | no | `SA0380000000608010167519` | SA + 22 digits |\n| `national_id` | string | no | `1023456789` | 10 digits, starts with 1 or 2 |\n| `vehicle_count` | string | no | `3-5` | 1-2 | 3-5 | 6-10 | 10+ |\n| `image` | file | no | `` | Avatar (JPG/PNG max 2MB) |\n\n## Example request\n```json\n{\n \"name\": \"Ahmed Al-Otaibi\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"iban\": \"SA0380000000608010167519\",\n \"national_id\": \"1023456789\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed Al-Otaibi\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"iban\": \"SA0380000000608010167519\",\n \"national_id\": \"1023456789\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"يرجى اعادة تسجيل الدخول\"\n}" } ] }, { "name": "Remove profile photo", "description": "## Purpose\nRemove the provider profile photo and return the default avatar from app settings.\n\n## Figma screen\n\n- **Screen:** Update profile\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-update profile.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n", "request": { "method": "DELETE", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/profile/image", "host": [ "{{base_url}}" ], "path": [ "provider", "profile", "image" ] }, "description": "## Purpose\nRemove the provider profile photo and return the default avatar from app settings.\n\n## Figma screen\n\n- **Screen:** Update profile\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-update profile.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/profile/image", "host": [ "{{base_url}}" ], "path": [ "provider", "profile", "image" ] }, "description": "## Purpose\nRemove the provider profile photo and return the default avatar from app settings.\n\n## Figma screen\n\n- **Screen:** Update profile\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-update profile.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}" } ] }, { "name": "Update password", "description": "## Purpose\nChange password while logged in. Requires current password (`old_password`) and new password (`password`, min 8 chars with letters and numbers).\n\n## Figma screen\n\n- **Screen:** Change password\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `old_password` | string | yes | `{{provider_password}}` | Current password |\n| `password` | string | yes | `NewPass123!` | New password |\n\n## Example request\n```json\n{\n \"old_password\": \"{{provider_password}}\",\n \"password\": \"NewPass123!\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "request": { "method": "PATCH", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/update-password", "host": [ "{{base_url}}" ], "path": [ "provider", "update-password" ] }, "description": "## Purpose\nChange password while logged in. Requires current password (`old_password`) and new password (`password`, min 8 chars with letters and numbers).\n\n## Figma screen\n\n- **Screen:** Change password\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `old_password` | string | yes | `{{provider_password}}` | Current password |\n| `password` | string | yes | `NewPass123!` | New password |\n\n## Example request\n```json\n{\n \"old_password\": \"{{provider_password}}\",\n \"password\": \"NewPass123!\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"old_password\": \"{{provider_password}}\",\n \"password\": \"NewPass123!\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/update-password", "host": [ "{{base_url}}" ], "path": [ "provider", "update-password" ] }, "description": "## Purpose\nChange password while logged in. Requires current password (`old_password`) and new password (`password`, min 8 chars with letters and numbers).\n\n## Figma screen\n\n- **Screen:** Change password\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-change password.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `old_password` | string | yes | `{{provider_password}}` | Current password |\n| `password` | string | yes | `NewPass123!` | New password |\n\n## Example request\n```json\n{\n \"old_password\": \"{{provider_password}}\",\n \"password\": \"NewPass123!\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"old_password\": \"{{provider_password}}\",\n \"password\": \"NewPass123!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}" } ] }, { "name": "Change language", "description": "## Purpose\nUpdate `preferred_locale` on device record.\n\n## Figma screen\n\n- **Screen:** Language\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `device_id` | string | yes | `postman-provider-1` | |\n| `device_type` | string | yes | `web` | |\n| `mac_address` | string | yes | `00:00:00:00:00:00` | |\n| `preferred_locale` | string | yes | `ar` | ar | en |\n\n## Example request\n```json\n{\n \"device_id\": \"postman-provider-1\",\n \"device_type\": \"web\",\n \"mac_address\": \"00:00:00:00:00:00\",\n \"preferred_locale\": \"ar\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "request": { "method": "PATCH", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/change-lang", "host": [ "{{base_url}}" ], "path": [ "provider", "change-lang" ] }, "description": "## Purpose\nUpdate `preferred_locale` on device record.\n\n## Figma screen\n\n- **Screen:** Language\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `device_id` | string | yes | `postman-provider-1` | |\n| `device_type` | string | yes | `web` | |\n| `mac_address` | string | yes | `00:00:00:00:00:00` | |\n| `preferred_locale` | string | yes | `ar` | ar | en |\n\n## Example request\n```json\n{\n \"device_id\": \"postman-provider-1\",\n \"device_type\": \"web\",\n \"mac_address\": \"00:00:00:00:00:00\",\n \"preferred_locale\": \"ar\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"device_id\": \"postman-provider-1\",\n \"device_type\": \"web\",\n \"mac_address\": \"00:00:00:00:00:00\",\n \"preferred_locale\": \"ar\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Live 200", "originalRequest": { "method": "PATCH", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/change-lang", "host": [ "{{base_url}}" ], "path": [ "provider", "change-lang" ] }, "description": "## Purpose\nUpdate `preferred_locale` on device record.\n\n## Figma screen\n\n- **Screen:** Language\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `device_id` | string | yes | `postman-provider-1` | |\n| `device_type` | string | yes | `web` | |\n| `mac_address` | string | yes | `00:00:00:00:00:00` | |\n| `preferred_locale` | string | yes | `ar` | ar | en |\n\n## Example request\n```json\n{\n \"device_id\": \"postman-provider-1\",\n \"device_type\": \"web\",\n \"mac_address\": \"00:00:00:00:00:00\",\n \"preferred_locale\": \"ar\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"device_id\": \"postman-provider-1\",\n \"device_type\": \"web\",\n \"mac_address\": \"00:00:00:00:00:00\",\n \"preferred_locale\": \"ar\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"يرجى اعادة تسجيل الدخول\"\n}" } ] } ] }, { "name": "04 — Notifications", "description": "Investor notification inbox (`I-NOTIF`).", "item": [ { "name": "Switch notifications", "description": "## Purpose\nToggle `is_notify`.\n\n## Figma screen\n\n- **Screen:** Notifications toggle\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n", "request": { "method": "PATCH", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/switch-notify", "host": [ "{{base_url}}" ], "path": [ "provider", "switch-notify" ] }, "description": "## Purpose\nToggle `is_notify`.\n\n## Figma screen\n\n- **Screen:** Notifications toggle\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "PATCH", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/switch-notify", "host": [ "{{base_url}}" ], "path": [ "provider", "switch-notify" ] }, "description": "## Purpose\nToggle `is_notify`.\n\n## Figma screen\n\n- **Screen:** Notifications toggle\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"يرجى اعادة تسجيل الدخول\"\n}" } ] }, { "name": "List notifications", "description": "## Purpose\nPaginated inbox.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `page` | integer | no | `1` | Page number |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"page\": \"1\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/notifications?page=1", "host": [ "{{base_url}}" ], "path": [ "provider", "notifications" ], "query": [ { "key": "page", "value": "1", "description": "Page", "disabled": false } ] }, "description": "## Purpose\nPaginated inbox.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `page` | integer | no | `1` | Page number |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"page\": \"1\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/notifications?page=1", "host": [ "{{base_url}}" ], "path": [ "provider", "notifications" ], "query": [ { "key": "page", "value": "1", "description": "Page", "disabled": false } ] }, "description": "## Purpose\nPaginated inbox.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `page` | integer | no | `1` | Page number |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"page\": \"1\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"يرجى اعادة تسجيل الدخول\"\n}" } ] }, { "name": "Count unread", "description": "## Purpose\nUnread count for dashboard badge.\n\n## Figma screen\n\n- **Screen:** Dashboard header\n- **Feature ID:** `I-HOME`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/count-notifications", "host": [ "{{base_url}}" ], "path": [ "provider", "count-notifications" ] }, "description": "## Purpose\nUnread count for dashboard badge.\n\n## Figma screen\n\n- **Screen:** Dashboard header\n- **Feature ID:** `I-HOME`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/count-notifications", "host": [ "{{base_url}}" ], "path": [ "provider", "count-notifications" ] }, "description": "## Purpose\nUnread count for dashboard badge.\n\n## Figma screen\n\n- **Screen:** Dashboard header\n- **Feature ID:** `I-HOME`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"unauthenticated\",\n \"msg\": \"يرجى اعادة تسجيل الدخول\"\n}" } ] }, { "name": "Mark all as read", "description": "## Purpose\nMark every unread notification as read. Returns `count: 0`.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n", "request": { "method": "PATCH", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/notifications/read-all", "host": [ "{{base_url}}" ], "path": [ "provider", "notifications", "read-all" ] }, "description": "## Purpose\nMark every unread notification as read. Returns `count: 0`.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/notifications/read-all", "host": [ "{{base_url}}" ], "path": [ "provider", "notifications", "read-all" ] }, "description": "## Purpose\nMark every unread notification as read. Returns `count: 0`.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"count\": 0\n }\n}" } ] }, { "name": "Mark one as read", "description": "## Purpose\nMark a single notification as read. Returns remaining unread `count`.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `notification_id` | string | yes | `9b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e` | Notification UUID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n", "request": { "method": "PATCH", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/notifications/{{notification_id}}/read", "host": [ "{{base_url}}" ], "path": [ "provider", "notifications", "{notification_id}", "read" ], "variable": [ { "key": "notification_id", "value": "{{notification_id}}", "description": "Path parameter" } ] }, "description": "## Purpose\nMark a single notification as read. Returns remaining unread `count`.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `notification_id` | string | yes | `9b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e` | Notification UUID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/notifications/{{notification_id}}/read", "host": [ "{{base_url}}" ], "path": [ "provider", "notifications", "{notification_id}", "read" ], "variable": [ { "key": "notification_id", "value": "{{notification_id}}", "description": "Path parameter" } ] }, "description": "## Purpose\nMark a single notification as read. Returns remaining unread `count`.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `notification_id` | string | yes | `9b2c3d4e-5f6a-7b8c-9d0e-1f2a3b4c5d6e` | Notification UUID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"count\": 2\n }\n}" } ] }, { "name": "Delete one notification", "description": "## Purpose\nDelete single notification.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `notification_id` | integer | yes | `1` | Path ID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n", "request": { "method": "DELETE", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/delete-notification/{{notification_id}}", "host": [ "{{base_url}}" ], "path": [ "provider", "delete-notification", "{notification_id}" ], "variable": [ { "key": "notification_id", "value": "{{notification_id}}", "description": "Path parameter" } ] }, "description": "## Purpose\nDelete single notification.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `notification_id` | integer | yes | `1` | Path ID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/delete-notification/{{notification_id}}", "host": [ "{{base_url}}" ], "path": [ "provider", "delete-notification", "{notification_id}" ], "variable": [ { "key": "notification_id", "value": "{{notification_id}}", "description": "Path parameter" } ] }, "description": "## Purpose\nDelete single notification.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `notification_id` | integer | yes | `1` | Path ID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}" } ] }, { "name": "Delete all notifications", "description": "## Purpose\nClear all notifications.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n", "request": { "method": "DELETE", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "provider", "delete-notifications" ] }, "description": "## Purpose\nClear all notifications.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/delete-notifications", "host": [ "{{base_url}}" ], "path": [ "provider", "delete-notifications" ] }, "description": "## Purpose\nClear all notifications.\n\n## Figma screen\n\n- **Screen:** Notifications inbox\n- **Feature ID:** `I-NOTIF`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — DELETE request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}" } ] } ] }, { "name": "05 — Phone update", "description": "**I-ACC-04** — change registered phone (4 steps). Requires `{{provider_token}}`.\n\nAfter provider forgot-password, set `otp_code` from: `SELECT code FROM auth_otps WHERE otpable_type LIKE '%Provider%' ORDER BY id DESC LIMIT 1`", "item": [ { "name": "1 — Send code to old phone", "description": "## Purpose\nOTP to current phone. Body optional if it matches profile.\n\n## Figma screen\n\n- **Screen:** Change phone — step 1\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `country_code` | string | no | `966` | |\n| `phone` | string | no | `512345678` | |\n\n## Example request\n```json\n{\n \"country_code\": \"{{provider_country_code}}\",\n \"phone\": \"{{provider_phone}}\"\n}\n```\n\n## Notes\nAfter provider forgot-password, set `otp_code` from: `SELECT code FROM auth_otps WHERE otpable_type LIKE '%Provider%' ORDER BY id DESC LIMIT 1`\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/send-code-to-old-phone", "host": [ "{{base_url}}" ], "path": [ "provider", "send-code-to-old-phone" ] }, "description": "## Purpose\nOTP to current phone. Body optional if it matches profile.\n\n## Figma screen\n\n- **Screen:** Change phone — step 1\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `country_code` | string | no | `966` | |\n| `phone` | string | no | `512345678` | |\n\n## Example request\n```json\n{\n \"country_code\": \"{{provider_country_code}}\",\n \"phone\": \"{{provider_phone}}\"\n}\n```\n\n## Notes\nAfter provider forgot-password, set `otp_code` from: `SELECT code FROM auth_otps WHERE otpable_type LIKE '%Provider%' ORDER BY id DESC LIMIT 1`\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"{{provider_country_code}}\",\n \"phone\": \"{{provider_phone}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/send-code-to-old-phone", "host": [ "{{base_url}}" ], "path": [ "provider", "send-code-to-old-phone" ] }, "description": "## Purpose\nOTP to current phone. Body optional if it matches profile.\n\n## Figma screen\n\n- **Screen:** Change phone — step 1\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `country_code` | string | no | `966` | |\n| `phone` | string | no | `512345678` | |\n\n## Example request\n```json\n{\n \"country_code\": \"{{provider_country_code}}\",\n \"phone\": \"{{provider_phone}}\"\n}\n```\n\n## Notes\nAfter provider forgot-password, set `otp_code` from: `SELECT code FROM auth_otps WHERE otpable_type LIKE '%Provider%' ORDER BY id DESC LIMIT 1`\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"{{provider_country_code}}\",\n \"phone\": \"{{provider_phone}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}" } ] }, { "name": "2 — Verify old phone", "description": "## Purpose\nConfirm OTP on current number.\n\n## Figma screen\n\n- **Screen:** Change phone — verify old\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `code` | string | yes | `{{otp_code}}` | |\n\n## Example request\n```json\n{\n \"code\": \"{{otp_code}}\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/verify-old-phone", "host": [ "{{base_url}}" ], "path": [ "provider", "verify-old-phone" ] }, "description": "## Purpose\nConfirm OTP on current number.\n\n## Figma screen\n\n- **Screen:** Change phone — verify old\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `code` | string | yes | `{{otp_code}}` | |\n\n## Example request\n```json\n{\n \"code\": \"{{otp_code}}\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"code\": \"{{otp_code}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/verify-old-phone", "host": [ "{{base_url}}" ], "path": [ "provider", "verify-old-phone" ] }, "description": "## Purpose\nConfirm OTP on current number.\n\n## Figma screen\n\n- **Screen:** Change phone — verify old\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `code` | string | yes | `{{otp_code}}` | |\n\n## Example request\n```json\n{\n \"code\": \"{{otp_code}}\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"code\": \"{{otp_code}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}" } ] }, { "name": "3 — Send code to new phone", "description": "## Purpose\nOTP to new Saudi mobile (unique).\n\n## Figma screen\n\n- **Screen:** Change phone — new number\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `country_code` | string | yes | `966` | |\n| `phone` | string | yes | `512345680` | Starts with 5 |\n\n## Example request\n```json\n{\n \"country_code\": \"966\",\n \"phone\": \"512345680\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/send-code-to-new-phone", "host": [ "{{base_url}}" ], "path": [ "provider", "send-code-to-new-phone" ] }, "description": "## Purpose\nOTP to new Saudi mobile (unique).\n\n## Figma screen\n\n- **Screen:** Change phone — new number\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `country_code` | string | yes | `966` | |\n| `phone` | string | yes | `512345680` | Starts with 5 |\n\n## Example request\n```json\n{\n \"country_code\": \"966\",\n \"phone\": \"512345680\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345680\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/send-code-to-new-phone", "host": [ "{{base_url}}" ], "path": [ "provider", "send-code-to-new-phone" ] }, "description": "## Purpose\nOTP to new Saudi mobile (unique).\n\n## Figma screen\n\n- **Screen:** Change phone — new number\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `country_code` | string | yes | `966` | |\n| `phone` | string | yes | `512345680` | Starts with 5 |\n\n## Example request\n```json\n{\n \"country_code\": \"966\",\n \"phone\": \"512345680\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345680\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}" } ] }, { "name": "4 — Verify new phone", "description": "## Purpose\nConfirm OTP and save new phone.\n\n## Figma screen\n\n- **Screen:** Change phone — confirm\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `code` | string | yes | `{{otp_code}}` | |\n| `country_code` | string | yes | `966` | |\n| `phone` | string | yes | `512345680` | |\n\n## Example request\n```json\n{\n \"country_code\": \"966\",\n \"phone\": \"512345680\",\n \"code\": \"{{otp_code}}\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345680\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/verify-new-phone", "host": [ "{{base_url}}" ], "path": [ "provider", "verify-new-phone" ] }, "description": "## Purpose\nConfirm OTP and save new phone.\n\n## Figma screen\n\n- **Screen:** Change phone — confirm\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `code` | string | yes | `{{otp_code}}` | |\n| `country_code` | string | yes | `966` | |\n| `phone` | string | yes | `512345680` | |\n\n## Example request\n```json\n{\n \"country_code\": \"966\",\n \"phone\": \"512345680\",\n \"code\": \"{{otp_code}}\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345680\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345680\",\n \"code\": \"{{otp_code}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/provider/verify-new-phone", "host": [ "{{base_url}}" ], "path": [ "provider", "verify-new-phone" ] }, "description": "## Purpose\nConfirm OTP and save new phone.\n\n## Figma screen\n\n- **Screen:** Change phone — confirm\n- **Feature ID:** `I-ACC-04`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `code` | string | yes | `{{otp_code}}` | |\n| `country_code` | string | yes | `966` | |\n| `phone` | string | yes | `512345680` | |\n\n## Example request\n```json\n{\n \"country_code\": \"966\",\n \"phone\": \"512345680\",\n \"code\": \"{{otp_code}}\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345680\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"country_code\": \"966\",\n \"phone\": \"512345680\",\n \"code\": \"{{otp_code}}\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"first_name\": \"أحمد\",\n \"last_name\": \"المستثمر\",\n \"name\": \"أحمد المستثمر\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345680\",\n \"country_code\": \"966\",\n \"full_phone\": \"966512345678\",\n \"image\": \"http://beeb.test/storage/images/providers/default.png\",\n \"avatar_initials\": \"أم\",\n \"is_approved\": true,\n \"is_verified\": true,\n \"is_active\": true,\n \"is_blocked\": false,\n \"is_notify\": true,\n \"has_vehicles\": true,\n \"investor_since\": \"مستثمر منذ يونيو 2024\",\n \"membership_months\": 14,\n \"profit_rate\": 18,\n \"profit_rate_label\": \"18% نسبة الأرباح\",\n \"vehicle_count\": \"3-5\",\n \"vehicles_count\": 7,\n \"national_id\": \"••••••••89\",\n \"iban\": \"SA••••••••••••••••••7519\",\n \"iban_full\": \"SA0380000000608010167519\",\n \"has_pending_profile_update\": false,\n \"documents\": [\n \"http://beeb.test/storage/images/providers/example-id.png\",\n \"http://beeb.test/storage/images/providers/example-iban.png\"\n ],\n \"dashboard_preview\": {\n \"rides_today\": 124,\n \"profit_share_percent\": 18,\n \"active_vehicles\": 7\n },\n \"code\": \"\",\n \"token\": \"1|sanctum-provider-token\",\n \"preferred_locale\": \"ar\",\n \"unread_notifications_count\": 0\n }\n}" } ] } ] }, { "name": "06 — Support & complaints", "description": "Investor support tickets (`I-ACC`). Requires `{{provider_token}}`. Images optional (form-data, max 5).", "item": [ { "name": "List complaints", "description": "## Purpose\nComplaint history for the logged-in investor. Optional `status` filter: `new`, `pending`, `finish`.\n\n## Figma screen\n\n- **Screen:** Support — complaints list\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `page` | integer | no | `1` | Page number |\n| `perPage` | integer | no | `15` | Items per page |\n| `status` | string | no | `new` | Filter by status |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"page\": \"1\",\n \"perPage\": \"15\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/complains?page=1&perPage=15", "host": [ "{{base_url}}" ], "path": [ "provider", "complains" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "perPage", "value": "15", "description": "Items per page", "disabled": false } ] }, "description": "## Purpose\nComplaint history for the logged-in investor. Optional `status` filter: `new`, `pending`, `finish`.\n\n## Figma screen\n\n- **Screen:** Support — complaints list\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `page` | integer | no | `1` | Page number |\n| `perPage` | integer | no | `15` | Items per page |\n| `status` | string | no | `new` | Filter by status |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"page\": \"1\",\n \"perPage\": \"15\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/complains?page=1&perPage=15", "host": [ "{{base_url}}" ], "path": [ "provider", "complains" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "perPage", "value": "15", "description": "Items per page", "disabled": false } ] }, "description": "## Purpose\nComplaint history for the logged-in investor. Optional `status` filter: `new`, `pending`, `finish`.\n\n## Figma screen\n\n- **Screen:** Support — complaints list\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `page` | integer | no | `1` | Page number |\n| `perPage` | integer | no | `15` | Items per page |\n| `status` | string | no | `new` | Filter by status |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"page\": \"1\",\n \"perPage\": \"15\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"data\": [],\n \"pagination\": {\n \"total\": 0\n }\n }\n}" } ] }, { "name": "Create complaint", "description": "## Purpose\nOpen a support ticket. Images are optional (up to 5). Use **form-data** when attaching files.\n\n## Figma screen\n\n- **Screen:** Support — new complaint\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `title` | string | yes | `Settlement delay` | Short title |\n| `description` | string | yes | `Pending payout for March` | 10–1000 characters |\n| `images[]` | file[] | no | `` | Optional. Up to 5 images (jpeg/png/jpg) |\n\n## Example request\n```json\n{\n \"title\": \"Settlement delay\",\n \"description\": \"My March settlement has not been processed yet.\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/complains", "host": [ "{{base_url}}" ], "path": [ "provider", "complains" ] }, "description": "## Purpose\nOpen a support ticket. Images are optional (up to 5). Use **form-data** when attaching files.\n\n## Figma screen\n\n- **Screen:** Support — new complaint\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `title` | string | yes | `Settlement delay` | Short title |\n| `description` | string | yes | `Pending payout for March` | 10–1000 characters |\n| `images[]` | file[] | no | `` | Optional. Up to 5 images (jpeg/png/jpg) |\n\n## Example request\n```json\n{\n \"title\": \"Settlement delay\",\n \"description\": \"My March settlement has not been processed yet.\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "formdata", "formdata": [ { "key": "title", "description": "Short title", "type": "text", "disabled": false, "value": "Settlement delay" }, { "key": "description", "description": "10–1000 chars", "type": "text", "disabled": false, "value": "My March settlement has not been processed yet." }, { "key": "images[]", "description": "Attach image(s)", "type": "file", "disabled": false, "value": "" } ] } }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/complains", "host": [ "{{base_url}}" ], "path": [ "provider", "complains" ] }, "description": "## Purpose\nOpen a support ticket. Images are optional (up to 5). Use **form-data** when attaching files.\n\n## Figma screen\n\n- **Screen:** Support — new complaint\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `title` | string | yes | `Settlement delay` | Short title |\n| `description` | string | yes | `Pending payout for March` | 10–1000 characters |\n| `images[]` | file[] | no | `` | Optional. Up to 5 images (jpeg/png/jpg) |\n\n## Example request\n```json\n{\n \"title\": \"Settlement delay\",\n \"description\": \"My March settlement has not been processed yet.\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "formdata", "formdata": [ { "key": "title", "description": "Short title", "type": "text", "disabled": false, "value": "Settlement delay" }, { "key": "description", "description": "10–1000 chars", "type": "text", "disabled": false, "value": "My March settlement has not been processed yet." }, { "key": "images[]", "description": "Attach image(s)", "type": "file", "disabled": false, "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}" } ] }, { "name": "Get complaint", "description": "## Purpose\nComplaint detail including admin reply and images.\n\n## Figma screen\n\n- **Screen:** Support — complaint detail\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `id` | integer | yes | `1` | Complaint ID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/complains/1", "host": [ "{{base_url}}" ], "path": [ "provider", "complains", "{id}" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter" } ] }, "description": "## Purpose\nComplaint detail including admin reply and images.\n\n## Figma screen\n\n- **Screen:** Support — complaint detail\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `id` | integer | yes | `1` | Complaint ID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/complains/1", "host": [ "{{base_url}}" ], "path": [ "provider", "complains", "{id}" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter" } ] }, "description": "## Purpose\nComplaint detail including admin reply and images.\n\n## Figma screen\n\n- **Screen:** Support — complaint detail\n- **Feature ID:** `I-ACC`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `id` | integer | yes | `1` | Complaint ID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"complain_number\": \"CP-20260604-ABCDEFGH\"\n }\n}" } ] } ] }, { "name": "07 — Dashboard", "description": "Investor analytics (`I-HOME`, `I-VEH`, `I-EARN`). Requires **approved** provider (`is_approved: true`).\n\n**Prerequisite:** Login → `{{provider_token}}`.\n\n| Screen | PNG |\n|--------|-----|\n| Home KPIs | `provider-home statistics.png` |\n| Vehicles | `provider-vehicles.png` |\n| Earnings | `provider-profit statistiscs.png` |", "item": [ { "name": "Home (KPIs & charts)", "description": "## Purpose\n**I-HOME** — 4 KPI cards, profit share, 6-month chart. Scooter activity table: `GET provider/transactions` (paginated).\n\n## Figma screen\n\n- **Screen:** Home statistics\n- **Feature ID:** `I-HOME`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-home statistics.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/home", "host": [ "{{base_url}}" ], "path": [ "provider", "home" ] }, "description": "## Purpose\n**I-HOME** — 4 KPI cards, profit share, 6-month chart. Scooter activity table: `GET provider/transactions` (paginated).\n\n## Figma screen\n\n- **Screen:** Home statistics\n- **Feature ID:** `I-HOME`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-home statistics.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/home", "host": [ "{{base_url}}" ], "path": [ "provider", "home" ] }, "description": "## Purpose\n**I-HOME** — 4 KPI cards, profit share, 6-month chart. Scooter activity table: `GET provider/transactions` (paginated).\n\n## Figma screen\n\n- **Screen:** Home statistics\n- **Feature ID:** `I-HOME`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-home statistics.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"currency\": \"SAR\",\n \"cards\": {\n \"trips_today\": {\n \"value\": 124,\n \"avg_per_vehicle\": 17.699999999999999289457264239899814128875732421875\n },\n \"revenue_today\": {\n \"value\": 745,\n \"your_share\": 134.099999999999994315658113919198513031005859375,\n \"vs_yesterday_percent\": 12.0999999999999996447286321199499070644378662109375,\n \"change\": {\n \"percent\": 12.0999999999999996447286321199499070644378662109375,\n \"formatted\": \"+12.1%\",\n \"trend\": \"up\",\n \"period\": \"yesterday\",\n \"label\": \"from yesterday\"\n }\n },\n \"vehicles\": {\n \"total\": 7,\n \"active\": 5,\n \"maintenance\": 2,\n \"in_ride\": 0,\n \"inactive\": 0\n },\n \"total_profits\": {\n \"value\": 12450,\n \"mom_percent\": 8.300000000000000710542735760100185871124267578125,\n \"change\": {\n \"percent\": 8.300000000000000710542735760100185871124267578125,\n \"formatted\": \"+8.3%\",\n \"trend\": \"up\",\n \"period\": \"this_month\",\n \"label\": \"this month\"\n }\n }\n },\n \"profit_share\": {\n \"percent\": 18,\n \"subtitle\": \"Of your total vehicle revenue\",\n \"expected_profit_month\": 2241,\n \"expected_profit_month_label\": \"Total expected profit this month\"\n },\n \"monthly_profits_chart\": {\n \"range_months\": 6,\n \"bars\": [\n {\n \"month\": \"2025-10\",\n \"label\": \"October\",\n \"profit\": 1800,\n \"is_current\": false\n },\n {\n \"month\": \"2025-11\",\n \"label\": \"November\",\n \"profit\": 2200,\n \"is_current\": false\n },\n {\n \"month\": \"2025-12\",\n \"label\": \"December\",\n \"profit\": 2000,\n \"is_current\": false\n },\n {\n \"month\": \"2026-01\",\n \"label\": \"January\",\n \"profit\": 2800,\n \"is_current\": false\n },\n {\n \"month\": \"2026-02\",\n \"label\": \"February\",\n \"profit\": 3100,\n \"is_current\": false\n },\n {\n \"month\": \"2026-03\",\n \"label\": \"March\",\n \"profit\": 2500,\n \"is_current\": true\n }\n ]\n }\n }\n}" } ] }, { "name": "Vehicles list", "description": "## Purpose\n**I-VEH** — summary counts + fleet cards. Optional filter `status` (active, in_ride, maintenance, inactive, out_of_service).\n\n## Figma screen\n\n- **Screen:** Vehicles list\n- **Feature ID:** `I-FLEET`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-vehicles.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `status` | string | no | `` | Optional ScooterStatus filter |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"status\": \"\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/vehicles?status=", "host": [ "{{base_url}}" ], "path": [ "provider", "vehicles" ], "query": [ { "key": "status", "value": "", "description": "Optional filter", "disabled": false } ] }, "description": "## Purpose\n**I-VEH** — summary counts + fleet cards. Optional filter `status` (active, in_ride, maintenance, inactive, out_of_service).\n\n## Figma screen\n\n- **Screen:** Vehicles list\n- **Feature ID:** `I-FLEET`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-vehicles.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `status` | string | no | `` | Optional ScooterStatus filter |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"status\": \"\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/vehicles?status=", "host": [ "{{base_url}}" ], "path": [ "provider", "vehicles" ], "query": [ { "key": "status", "value": "", "description": "Optional filter", "disabled": false } ] }, "description": "## Purpose\n**I-VEH** — summary counts + fleet cards. Optional filter `status` (active, in_ride, maintenance, inactive, out_of_service).\n\n## Figma screen\n\n- **Screen:** Vehicles list\n- **Feature ID:** `I-FLEET`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-vehicles.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `status` | string | no | `` | Optional ScooterStatus filter |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"status\": \"\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"summary\": {\n \"total\": 7,\n \"active\": 5,\n \"maintenance\": 1,\n \"in_ride\": 1,\n \"inactive\": 0\n },\n \"vehicles\": [\n {\n \"id\": 1,\n \"code\": \"SCT-0001\",\n \"model\": \"Ninebot Max G30\",\n \"status\": \"active\",\n \"status_label\": \"Available\",\n \"battery_percent\": 82,\n \"image\": \"http://beeb.test/storage/images/scooters/default.png\",\n \"location\": \"Riyadh\",\n \"rides_today\": 3,\n \"revenue_today\": 45.2000000000000028421709430404007434844970703125,\n \"your_share_today\": 8.1400000000000005684341886080801486968994140625,\n \"currency\": \"SAR\"\n }\n ]\n }\n}" } ] }, { "name": "Vehicle detail", "description": "## Purpose\n**I-VEH** — per-scooter revenue, rides, utilization, recent rides.\n\n## Figma screen\n\n- **Screen:** Vehicle detail\n- **Feature ID:** `I-VEH`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-vehicles.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/vehicles/1", "host": [ "{{base_url}}" ], "path": [ "provider", "vehicles", "{id}" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter" } ] }, "description": "## Purpose\n**I-VEH** — per-scooter revenue, rides, utilization, recent rides.\n\n## Figma screen\n\n- **Screen:** Vehicle detail\n- **Feature ID:** `I-VEH`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-vehicles.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/vehicles/1", "host": [ "{{base_url}}" ], "path": [ "provider", "vehicles", "{id}" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter" } ] }, "description": "## Purpose\n**I-VEH** — per-scooter revenue, rides, utilization, recent rides.\n\n## Figma screen\n\n- **Screen:** Vehicle detail\n- **Feature ID:** `I-VEH`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-vehicles.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"id\": 1,\n \"code\": \"SCT-0001\",\n \"model\": \"Ninebot Max G30\",\n \"status\": \"active\",\n \"status_label\": \"Available\",\n \"battery_percent\": 82,\n \"location\": \"Riyadh\",\n \"revenue\": {\n \"today\": 45.2000000000000028421709430404007434844970703125,\n \"week\": 210,\n \"month\": 680\n },\n \"your_share\": {\n \"today\": 8.1400000000000005684341886080801486968994140625,\n \"month\": 122.400000000000005684341886080801486968994140625\n },\n \"rides\": {\n \"today\": 3,\n \"total\": 48,\n \"avg_duration_min\": 12.5\n },\n \"utilization_percent\": 65,\n \"recent_rides\": [],\n \"currency\": \"SAR\"\n }\n}" } ] }, { "name": "Earnings & profit stats", "description": "## Purpose\n**I-EARN** — KPIs, monthly chart, YoY comparison. Per-vehicle CSV: `GET provider/earnings/export`.\n\n## Figma screen\n\n- **Screen:** Profit statistics\n- **Feature ID:** `I-EARN`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-profit statistiscs.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `months` | string | no | `6` | Chart range 3–12 (default 6) |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"months\": \"6\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/earnings?months=6", "host": [ "{{base_url}}" ], "path": [ "provider", "earnings" ], "query": [ { "key": "months", "value": "6", "description": "Months for chart", "disabled": false } ] }, "description": "## Purpose\n**I-EARN** — KPIs, monthly chart, YoY comparison. Per-vehicle CSV: `GET provider/earnings/export`.\n\n## Figma screen\n\n- **Screen:** Profit statistics\n- **Feature ID:** `I-EARN`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-profit statistiscs.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `months` | string | no | `6` | Chart range 3–12 (default 6) |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"months\": \"6\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/earnings?months=6", "host": [ "{{base_url}}" ], "path": [ "provider", "earnings" ], "query": [ { "key": "months", "value": "6", "description": "Months for chart", "disabled": false } ] }, "description": "## Purpose\n**I-EARN** — KPIs, monthly chart, YoY comparison. Per-vehicle CSV: `GET provider/earnings/export`.\n\n## Figma screen\n\n- **Screen:** Profit statistics\n- **Feature ID:** `I-EARN`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-profit statistiscs.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `months` | string | no | `6` | Chart range 3–12 (default 6) |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"months\": \"6\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"profit_share_percent\": 18,\n \"kpis\": {\n \"profit_share_percent\": 18,\n \"avg_daily_profit_30d\": 28.10000000000000142108547152020037174224853515625,\n \"profit_this_month\": {\n \"value\": 2241,\n \"label\": \"This month's earnings\",\n \"change\": {\n \"percent\": 8.300000000000000710542735760100185871124267578125,\n \"formatted\": \"+8.3%\",\n \"trend\": \"up\",\n \"period\": \"last_month\",\n \"label\": \"from last month\"\n }\n },\n \"total_profit\": 4520.8000000000001818989403545856475830078125\n },\n \"monthly_earnings_chart\": [\n {\n \"month\": \"2026-06\",\n \"label\": \"Jun 2026\",\n \"revenue\": 4680,\n \"profit\": 842.3999999999999772626324556767940521240234375,\n \"is_current\": true\n }\n ],\n \"yearly_comparison\": {\n \"labels\": [\n \"Jan\",\n \"Feb\",\n \"Mar\"\n ],\n \"current_year\": [\n 120,\n 140,\n 160\n ],\n \"previous_year\": [\n 100,\n 110,\n 130\n ]\n },\n \"currency\": \"SAR\"\n }\n}" } ] }, { "name": "Earnings CSV export", "description": "## Purpose\n**I-EARN** — downloads `provider-earnings-YYYY-MM-DD.csv` (vehicles table columns).\n\n## Figma screen\n\n- **Screen:** Earnings table export\n- **Feature ID:** `I-EARN`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-profit statistiscs.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/earnings/export", "host": [ "{{base_url}}" ], "path": [ "provider", "earnings", "export" ] }, "description": "## Purpose\n**I-EARN** — downloads `provider-earnings-YYYY-MM-DD.csv` (vehicles table columns).\n\n## Figma screen\n\n- **Screen:** Earnings table export\n- **Feature ID:** `I-EARN`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-profit statistiscs.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/earnings/export", "host": [ "{{base_url}}" ], "path": [ "provider", "earnings", "export" ] }, "description": "## Purpose\n**I-EARN** — downloads `provider-earnings-YYYY-MM-DD.csv` (vehicles table columns).\n\n## Figma screen\n\n- **Screen:** Earnings table export\n- **Feature ID:** `I-EARN`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-profit statistiscs.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": []\n}" } ] }, { "name": "Earning transactions (per-vehicle earnings table)", "description": "## Purpose\n**I-EARN** — \"أرباح كل مركبة\" screen. Returns every vehicle owned by the investor with its monthly earnings, daily stats, utilization bar, and status. Sorted by `monthly_share` descending. Paginated.\n\n### Response fields per vehicle\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `scooter_id` | integer | DB id |\n| `code` | string | Vehicle code e.g. `SCT-0018` |\n| `status` | string | `active` \\| `maintenance` \\| `in_ride` \\| `inactive` |\n| `status_label` | string | Localised label |\n| `area` | string | Current area / neighbourhood |\n| `utilization_percent` | float | % of last 30 days with at least one ride (progress bar) |\n| `rides_today` | integer | Completed rides today |\n| `daily_revenue` | float | Total ride revenue today (SAR) |\n| `your_share_revenue` | float | Provider's share of today's revenue (`daily_revenue × your_share_percent / 100`) |\n| `monthly_revenue` | float | Total ride revenue this month (SAR) |\n| `your_share_percent` | float | Investor profit-share % (e.g. 18) |\n| `monthly_share` | float | `monthly_revenue × your_share_percent / 100` (highlighted column) |\n\n### Top-level fields (always cover ALL vehicles, not just the current page)\n\n| Field | Description |\n|-------|-------------|\n| `total_monthly_share` | Sum of all vehicles' `monthly_share` — \"إجمالي تصبيك هذا الشهر\" |\n\n### Pagination query params\n\n| Param | Default | Range |\n|-------|---------|-------|\n| `per_page` | 15 | 5–50 |\n| `page` | 1 | ≥ 1 |\n\n## Figma screen\n\n- **Screen:** Earning transactions — per-vehicle earnings table\n- **Feature ID:** `I-EARN`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-profit statistiscs.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `per_page` | integer | no | `15` | Items per page (5–50, default 15) |\n| `page` | integer | no | `1` | Page number (default 1) |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"page\": \"1\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/earning-transactions?per_page=15&page=1", "host": [ "{{base_url}}" ], "path": [ "provider", "earning-transactions" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page", "disabled": false }, { "key": "page", "value": "1", "description": "Page number", "disabled": false } ] }, "description": "## Purpose\n**I-EARN** — \"أرباح كل مركبة\" screen. Returns every vehicle owned by the investor with its monthly earnings, daily stats, utilization bar, and status. Sorted by `monthly_share` descending. Paginated.\n\n### Response fields per vehicle\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `scooter_id` | integer | DB id |\n| `code` | string | Vehicle code e.g. `SCT-0018` |\n| `status` | string | `active` \\| `maintenance` \\| `in_ride` \\| `inactive` |\n| `status_label` | string | Localised label |\n| `area` | string | Current area / neighbourhood |\n| `utilization_percent` | float | % of last 30 days with at least one ride (progress bar) |\n| `rides_today` | integer | Completed rides today |\n| `daily_revenue` | float | Total ride revenue today (SAR) |\n| `your_share_revenue` | float | Provider's share of today's revenue (`daily_revenue × your_share_percent / 100`) |\n| `monthly_revenue` | float | Total ride revenue this month (SAR) |\n| `your_share_percent` | float | Investor profit-share % (e.g. 18) |\n| `monthly_share` | float | `monthly_revenue × your_share_percent / 100` (highlighted column) |\n\n### Top-level fields (always cover ALL vehicles, not just the current page)\n\n| Field | Description |\n|-------|-------------|\n| `total_monthly_share` | Sum of all vehicles' `monthly_share` — \"إجمالي تصبيك هذا الشهر\" |\n\n### Pagination query params\n\n| Param | Default | Range |\n|-------|---------|-------|\n| `per_page` | 15 | 5–50 |\n| `page` | 1 | ≥ 1 |\n\n## Figma screen\n\n- **Screen:** Earning transactions — per-vehicle earnings table\n- **Feature ID:** `I-EARN`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-profit statistiscs.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `per_page` | integer | no | `15` | Items per page (5–50, default 15) |\n| `page` | integer | no | `1` | Page number (default 1) |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"page\": \"1\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/earning-transactions?per_page=15&page=1", "host": [ "{{base_url}}" ], "path": [ "provider", "earning-transactions" ], "query": [ { "key": "per_page", "value": "15", "description": "Items per page", "disabled": false }, { "key": "page", "value": "1", "description": "Page number", "disabled": false } ] }, "description": "## Purpose\n**I-EARN** — \"أرباح كل مركبة\" screen. Returns every vehicle owned by the investor with its monthly earnings, daily stats, utilization bar, and status. Sorted by `monthly_share` descending. Paginated.\n\n### Response fields per vehicle\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `scooter_id` | integer | DB id |\n| `code` | string | Vehicle code e.g. `SCT-0018` |\n| `status` | string | `active` \\| `maintenance` \\| `in_ride` \\| `inactive` |\n| `status_label` | string | Localised label |\n| `area` | string | Current area / neighbourhood |\n| `utilization_percent` | float | % of last 30 days with at least one ride (progress bar) |\n| `rides_today` | integer | Completed rides today |\n| `daily_revenue` | float | Total ride revenue today (SAR) |\n| `your_share_revenue` | float | Provider's share of today's revenue (`daily_revenue × your_share_percent / 100`) |\n| `monthly_revenue` | float | Total ride revenue this month (SAR) |\n| `your_share_percent` | float | Investor profit-share % (e.g. 18) |\n| `monthly_share` | float | `monthly_revenue × your_share_percent / 100` (highlighted column) |\n\n### Top-level fields (always cover ALL vehicles, not just the current page)\n\n| Field | Description |\n|-------|-------------|\n| `total_monthly_share` | Sum of all vehicles' `monthly_share` — \"إجمالي تصبيك هذا الشهر\" |\n\n### Pagination query params\n\n| Param | Default | Range |\n|-------|---------|-------|\n| `per_page` | 15 | 5–50 |\n| `page` | 1 | ≥ 1 |\n\n## Figma screen\n\n- **Screen:** Earning transactions — per-vehicle earnings table\n- **Feature ID:** `I-EARN`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-profit statistiscs.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `per_page` | integer | no | `15` | Items per page (5–50, default 15) |\n| `page` | integer | no | `1` | Page number (default 1) |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"page\": \"1\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"currency\": \"SAR\",\n \"profit_share_percent\": 18,\n \"vehicles\": [\n {\n \"scooter_id\": 18,\n \"code\": \"SCT-0018\",\n \"status\": \"active\",\n \"status_label\": \"نشط\",\n \"area\": \"حي اللقا\",\n \"utilization_percent\": 94,\n \"rides_today\": 34,\n \"daily_revenue\": 220,\n \"your_share_revenue\": 39.60000000000000142108547152020037174224853515625,\n \"monthly_revenue\": 4840,\n \"your_share_percent\": 18,\n \"monthly_share\": 871.200000000000045474735088646411895751953125\n },\n {\n \"scooter_id\": 42,\n \"code\": \"SCT-0042\",\n \"status\": \"active\",\n \"status_label\": \"نشط\",\n \"area\": \"حي النخيل\",\n \"utilization_percent\": 87,\n \"rides_today\": 23,\n \"daily_revenue\": 145,\n \"your_share_revenue\": 26.10000000000000142108547152020037174224853515625,\n \"monthly_revenue\": 3190,\n \"your_share_percent\": 18,\n \"monthly_share\": 574.200000000000045474735088646411895751953125\n }\n ],\n \"total_monthly_share\": 2573,\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 3,\n \"per_page\": 2,\n \"total\": 5\n }\n }\n}" } ] }, { "name": "Transactions (paginated, per scooter)", "description": "## Purpose\n**I-HOME** activity table — one row per scooter (no duplicate codes): `rides_count`, `revenue`, `your_share`, `last_ride_at`, `relative_time`. Sorted by latest ride.\n\n## Figma screen\n\n- **Screen:** Recent transactions\n- **Feature ID:** `I-HOME`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-home statistics.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n| `page` | string | no | `1` | Page number |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"page\": \"1\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/transactions?per_page=15&page=1", "host": [ "{{base_url}}" ], "path": [ "provider", "transactions" ], "query": [ { "key": "per_page", "value": "15", "description": "Page size", "disabled": false }, { "key": "page", "value": "1", "description": "Page", "disabled": false } ] }, "description": "## Purpose\n**I-HOME** activity table — one row per scooter (no duplicate codes): `rides_count`, `revenue`, `your_share`, `last_ride_at`, `relative_time`. Sorted by latest ride.\n\n## Figma screen\n\n- **Screen:** Recent transactions\n- **Feature ID:** `I-HOME`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-home statistics.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n| `page` | string | no | `1` | Page number |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"page\": \"1\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/transactions?per_page=15&page=1", "host": [ "{{base_url}}" ], "path": [ "provider", "transactions" ], "query": [ { "key": "per_page", "value": "15", "description": "Page size", "disabled": false }, { "key": "page", "value": "1", "description": "Page", "disabled": false } ] }, "description": "## Purpose\n**I-HOME** activity table — one row per scooter (no duplicate codes): `rides_count`, `revenue`, `your_share`, `last_ride_at`, `relative_time`. Sorted by latest ride.\n\n## Figma screen\n\n- **Screen:** Recent transactions\n- **Feature ID:** `I-HOME`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n- **Local reference:** `ai helper/provider/provider-home statistics.png`\n\n## Auth\nBearer {{provider_token}}\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n| `page` | string | no | `1` | Page number |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"page\": \"1\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"currency\": \"SAR\",\n \"transactions\": [\n {\n \"scooter_id\": 1,\n \"scooter_code\": \"SARA-001\",\n \"area\": \"Riyadh\",\n \"rides_count\": 18,\n \"revenue\": 142.5,\n \"your_share\": 25.64999999999999857891452847979962825775146484375,\n \"last_ride_at\": \"2026-06-04T14:22:00+03:00\",\n \"relative_time\": \"2 hours ago\",\n \"currency\": \"SAR\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 15,\n \"total\": 7\n }\n }\n}" } ] } ] }, { "name": "08 — Settlements", "description": "Investor settlement requests (`I-FIN`). Approved provider submits a request for completed rides; admin reviews and attaches transfer proof.\n\n**Flow:** Get settleable rides (preview) → POST create (all settleable rides included) → wait for admin review → check status.\n\n**Statuses:** `pending` → `under_review` → `accepted` | `rejected`\n\nRequires **approved** provider (`is_approved: true`).", "item": [ { "name": "Settleable rides", "description": "## Purpose\nCompleted rides **not yet included** in any settlement request + running totals.\n\nPreview before submitting; **create** includes all settleable rides automatically (no body).\n\n## Figma screen\n\n- **Screen:** Settlements — ride selection\n- **Feature ID:** `I-FIN-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `from` | string | no | `` | Filter start date YYYY-MM-DD |\n| `to` | string | no | `` | Filter end date YYYY-MM-DD |\n| `scooter_id` | string | no | `` | Filter by scooter ID |\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n| `paginate` | string | no | `true` | false = return all settleable rides |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"paginate\": \"true\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/settlements/settleable?per_page=15&paginate=true", "host": [ "{{base_url}}" ], "path": [ "provider", "settlements", "settleable" ], "query": [ { "key": "per_page", "value": "15", "description": "Page size", "disabled": false }, { "key": "paginate", "value": "true", "description": "Set false to get all", "disabled": false } ] }, "description": "## Purpose\nCompleted rides **not yet included** in any settlement request + running totals.\n\nPreview before submitting; **create** includes all settleable rides automatically (no body).\n\n## Figma screen\n\n- **Screen:** Settlements — ride selection\n- **Feature ID:** `I-FIN-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `from` | string | no | `` | Filter start date YYYY-MM-DD |\n| `to` | string | no | `` | Filter end date YYYY-MM-DD |\n| `scooter_id` | string | no | `` | Filter by scooter ID |\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n| `paginate` | string | no | `true` | false = return all settleable rides |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"paginate\": \"true\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/settlements/settleable?per_page=15&paginate=true", "host": [ "{{base_url}}" ], "path": [ "provider", "settlements", "settleable" ], "query": [ { "key": "per_page", "value": "15", "description": "Page size", "disabled": false }, { "key": "paginate", "value": "true", "description": "Set false to get all", "disabled": false } ] }, "description": "## Purpose\nCompleted rides **not yet included** in any settlement request + running totals.\n\nPreview before submitting; **create** includes all settleable rides automatically (no body).\n\n## Figma screen\n\n- **Screen:** Settlements — ride selection\n- **Feature ID:** `I-FIN-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `from` | string | no | `` | Filter start date YYYY-MM-DD |\n| `to` | string | no | `` | Filter end date YYYY-MM-DD |\n| `scooter_id` | string | no | `` | Filter by scooter ID |\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n| `paginate` | string | no | `true` | false = return all settleable rides |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"paginate\": \"true\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"summary\": {\n \"total_revenue\": 312.5,\n \"total_share\": 56.25,\n \"profit_rate\": 18,\n \"currency\": \"SAR\"\n },\n \"rides\": [\n {\n \"id\": 101,\n \"scooter_code\": \"SCT-0001\",\n \"ride_cost\": 55.25,\n \"share_amount\": 9.949999999999999289457264239899814128875732421875,\n \"ended_at\": \"2026-06-02T14:30:00+03:00\",\n \"start_address\": \"Riyadh\",\n \"end_address\": \"Riyadh\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 3,\n \"per_page\": 15,\n \"total\": 42\n }\n }\n}" } ] }, { "name": "Create settlement request", "description": "## Purpose\nSubmit a settlement for **all** completed rides that are settleable (not in a pending or accepted settlement).\n\nNo request body. Status becomes **`pending`** until admin reviews.\n\n## Figma screen\n\n- **Screen:** Settlements — create request\n- **Feature ID:** `I-FIN-02`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example request\n```json\n[]\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"settlement\": {\n \"id\": 1,\n \"status\": \"pending\",\n \"status_label\": \"Pending review\",\n \"rides_count\": 5,\n \"total_revenue\": 312.5,\n \"profit_rate\": 18,\n \"total_amount\": 56.25,\n \"currency\": \"SAR\",\n \"requested_at\": \"2026-06-03T10:00:00+03:00\",\n \"reviewed_at\": null,\n \"rejection_reason\": null,\n \"transfer_proof_url\": null\n }\n }\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/settlements", "host": [ "{{base_url}}" ], "path": [ "provider", "settlements" ] }, "description": "## Purpose\nSubmit a settlement for **all** completed rides that are settleable (not in a pending or accepted settlement).\n\nNo request body. Status becomes **`pending`** until admin reviews.\n\n## Figma screen\n\n- **Screen:** Settlements — create request\n- **Feature ID:** `I-FIN-02`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example request\n```json\n[]\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"settlement\": {\n \"id\": 1,\n \"status\": \"pending\",\n \"status_label\": \"Pending review\",\n \"rides_count\": 5,\n \"total_revenue\": 312.5,\n \"profit_rate\": 18,\n \"total_amount\": 56.25,\n \"currency\": \"SAR\",\n \"requested_at\": \"2026-06-03T10:00:00+03:00\",\n \"reviewed_at\": null,\n \"rejection_reason\": null,\n \"transfer_proof_url\": null\n }\n }\n}\n```\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/settlements", "host": [ "{{base_url}}" ], "path": [ "provider", "settlements" ] }, "description": "## Purpose\nSubmit a settlement for **all** completed rides that are settleable (not in a pending or accepted settlement).\n\nNo request body. Status becomes **`pending`** until admin reviews.\n\n## Figma screen\n\n- **Screen:** Settlements — create request\n- **Feature ID:** `I-FIN-02`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Example request\n```json\n[]\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"settlement\": {\n \"id\": 1,\n \"status\": \"pending\",\n \"status_label\": \"Pending review\",\n \"rides_count\": 5,\n \"total_revenue\": 312.5,\n \"profit_rate\": 18,\n \"total_amount\": 56.25,\n \"currency\": \"SAR\",\n \"requested_at\": \"2026-06-03T10:00:00+03:00\",\n \"reviewed_at\": null,\n \"rejection_reason\": null,\n \"transfer_proof_url\": null\n }\n }\n}\n```\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"settlement\": {\n \"id\": 1,\n \"status\": \"pending\",\n \"status_label\": \"Pending review\",\n \"rides_count\": 5,\n \"total_revenue\": 312.5,\n \"profit_rate\": 18,\n \"total_amount\": 56.25,\n \"currency\": \"SAR\",\n \"requested_at\": \"2026-06-03T10:00:00+03:00\",\n \"reviewed_at\": null,\n \"rejection_reason\": null,\n \"transfer_proof_url\": null\n }\n }\n}" } ] }, { "name": "List my settlements", "description": "## Purpose\nPaginated list of the investor's settlement requests. Filter by status.\n\n## Figma screen\n\n- **Screen:** Settlements — history list\n- **Feature ID:** `I-FIN-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `status` | string | no | `` | pending | under_review | accepted | rejected |\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"status\": \"\",\n \"per_page\": \"15\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/settlements?status=&per_page=15", "host": [ "{{base_url}}" ], "path": [ "provider", "settlements" ], "query": [ { "key": "status", "value": "", "description": "Filter by status", "disabled": false }, { "key": "per_page", "value": "15", "description": "Page size", "disabled": false } ] }, "description": "## Purpose\nPaginated list of the investor's settlement requests. Filter by status.\n\n## Figma screen\n\n- **Screen:** Settlements — history list\n- **Feature ID:** `I-FIN-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `status` | string | no | `` | pending | under_review | accepted | rejected |\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"status\": \"\",\n \"per_page\": \"15\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/settlements?status=&per_page=15", "host": [ "{{base_url}}" ], "path": [ "provider", "settlements" ], "query": [ { "key": "status", "value": "", "description": "Filter by status", "disabled": false }, { "key": "per_page", "value": "15", "description": "Page size", "disabled": false } ] }, "description": "## Purpose\nPaginated list of the investor's settlement requests. Filter by status.\n\n## Figma screen\n\n- **Screen:** Settlements — history list\n- **Feature ID:** `I-FIN-01`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `status` | string | no | `` | pending | under_review | accepted | rejected |\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"status\": \"\",\n \"per_page\": \"15\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"settlements\": [\n {\n \"id\": 1,\n \"status\": \"pending\",\n \"status_label\": \"Pending review\",\n \"rides_count\": 5,\n \"total_revenue\": 312.5,\n \"profit_rate\": 18,\n \"total_amount\": 56.25,\n \"currency\": \"SAR\",\n \"requested_at\": \"2026-06-03T10:00:00+03:00\",\n \"reviewed_at\": null\n },\n {\n \"id\": 2,\n \"status\": \"accepted\",\n \"status_label\": \"Accepted\",\n \"rides_count\": 12,\n \"total_revenue\": 820,\n \"profit_rate\": 18,\n \"total_amount\": 147.599999999999994315658113919198513031005859375,\n \"currency\": \"SAR\",\n \"requested_at\": \"2026-05-01T10:00:00+03:00\",\n \"reviewed_at\": \"2026-05-03T14:00:00+03:00\",\n \"transfer_proof_url\": \"http://beeb.test/storage/settlements/proof-2.pdf\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 15,\n \"total\": 2\n }\n }\n}" } ] }, { "name": "Settlement details", "description": "## Purpose\nFull settlement request: header info + paginated ride breakdown + transfer proof URL (when accepted) + reviewer info.\n\n## Figma screen\n\n- **Screen:** Settlement detail\n- **Feature ID:** `I-FIN-03`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n| `page` | string | no | `1` | Page number |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"page\": \"1\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/settlements/1?per_page=15&page=1", "host": [ "{{base_url}}" ], "path": [ "provider", "settlements", "{id}" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter" } ], "query": [ { "key": "per_page", "value": "15", "description": "Page size", "disabled": false }, { "key": "page", "value": "1", "description": "Page number", "disabled": false } ] }, "description": "## Purpose\nFull settlement request: header info + paginated ride breakdown + transfer proof URL (when accepted) + reviewer info.\n\n## Figma screen\n\n- **Screen:** Settlement detail\n- **Feature ID:** `I-FIN-03`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n| `page` | string | no | `1` | Page number |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"page\": \"1\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Authorization", "value": "Bearer {{provider_token}}", "description": "Sanctum bearer token" } ], "url": { "raw": "{{base_url}}/provider/settlements/1?per_page=15&page=1", "host": [ "{{base_url}}" ], "path": [ "provider", "settlements", "{id}" ], "variable": [ { "key": "id", "value": "1", "description": "Path parameter" } ], "query": [ { "key": "per_page", "value": "15", "description": "Page size", "disabled": false }, { "key": "page", "value": "1", "description": "Page number", "disabled": false } ] }, "description": "## Purpose\nFull settlement request: header info + paginated ride breakdown + transfer proof URL (when accepted) + reviewer info.\n\n## Figma screen\n\n- **Screen:** Settlement detail\n- **Feature ID:** `I-FIN-03`\n- **Link:** [Open file in Figma](https://www.figma.com/design/REPLACE_PROVIDER_FILE/BEEB-Investor-Dashboard)\n- **Setup:** Set `FIGMA_CLIENT_URL` / `FIGMA_PROVIDER_URL` in `.env` or edit `figma-screens.php`.\n\n## Auth\nBearer {{provider_token}}\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `per_page` | string | no | `15` | 5–50 (default 15) |\n| `page` | string | no | `1` | Page number |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"per_page\": \"15\",\n \"page\": \"1\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"settlement\": {\n \"id\": 1,\n \"status\": \"accepted\",\n \"status_label\": \"Accepted\",\n \"rides_count\": 3,\n \"total_revenue\": 165.75,\n \"profit_rate\": 18,\n \"total_amount\": 29.839999999999999857891452847979962825775146484375,\n \"currency\": \"SAR\",\n \"requested_at\": \"2026-06-03T10:00:00+03:00\",\n \"reviewed_at\": \"2026-06-04T09:00:00+03:00\",\n \"transfer_proof_url\": \"http://beeb.test/storage/settlements/proof-1.pdf\",\n \"rides\": [\n {\n \"id\": 101,\n \"scooter_code\": \"SCT-0001\",\n \"ride_cost\": 55.25,\n \"share_amount\": 9.949999999999999289457264239899814128875732421875,\n \"ended_at\": \"2026-06-02T14:30:00+03:00\",\n \"start_address\": \"Riyadh\",\n \"end_address\": \"Riyadh\"\n },\n {\n \"id\": 102,\n \"scooter_code\": \"SCT-0001\",\n \"ride_cost\": 72.5,\n \"share_amount\": 13.050000000000000710542735760100185871124267578125,\n \"ended_at\": \"2026-06-02T16:00:00+03:00\",\n \"start_address\": \"Riyadh\",\n \"end_address\": \"Riyadh\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"last_page\": 2,\n \"per_page\": 15,\n \"total\": 3\n },\n \"provider\": {\n \"id\": 1,\n \"name\": \"Ahmed Al-Otaibi\",\n \"email\": \"ahmed.investor@beeb.test\",\n \"phone\": \"512345678\"\n },\n \"reviewer\": {\n \"id\": 1,\n \"name\": \"Admin\"\n }\n }\n }\n}" } ] } ] } ] }, { "name": "General", "description": "Public — `/api/*` (no client/provider prefix)", "item": [ { "name": "01 — App settings", "description": "Platform config.", "item": [ { "name": "Settings", "description": "## Purpose\nPublic settings (pricing keys, etc.).\n\n## Figma screen\n\n- **Screen:** App config (backend)\n- **Feature ID:** `A-SETTINGS`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/settings", "host": [ "{{base_url}}" ], "path": [ "settings" ] }, "description": "## Purpose\nPublic settings (pricing keys, etc.).\n\n## Figma screen\n\n- **Screen:** App config (backend)\n- **Feature ID:** `A-SETTINGS`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/settings", "host": [ "{{base_url}}" ], "path": [ "settings" ] }, "description": "## Purpose\nPublic settings (pricing keys, etc.).\n\n## Figma screen\n\n- **Screen:** App config (backend)\n- **Feature ID:** `A-SETTINGS`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": {\n \"address\": \"شارع - الرياض - السعودية\",\n \"map_desc\": \"شارع - الرياض - السعودية\",\n \"lat\": \"12.23\",\n \"lng\": \"23.12\",\n \"phone\": \"+966555184424\",\n \"email\": \"codebase@gmail.com\",\n \"name\": \"اسم المشروع\",\n \"description\": \"وصف المشروع\",\n \"logo\": \"http://beeb.test/storage/images/settings/logo.png\",\n \"fav_icon\": \"http://beeb.test/storage/images/settings/fav_icon.png\"\n }\n}" } ] }, { "name": "Is production", "description": "## Purpose\nProduction flag.\n\n## Figma screen\n\n- **Screen:** App config (backend)\n- **Feature ID:** `A-SETTINGS`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/is-production", "host": [ "{{base_url}}" ], "path": [ "is-production" ] }, "description": "## Purpose\nProduction flag.\n\n## Figma screen\n\n- **Screen:** App config (backend)\n- **Feature ID:** `A-SETTINGS`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/is-production", "host": [ "{{base_url}}" ], "path": [ "is-production" ] }, "description": "## Purpose\nProduction flag.\n\n## Figma screen\n\n- **Screen:** App config (backend)\n- **Feature ID:** `A-SETTINGS`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Method App\\\\Http\\\\Controllers\\\\Api\\\\SettingController::isProduction does not exist.\"\n}" } ] }, { "name": "Main settings", "description": "## Purpose\nMain config block.\n\n## Figma screen\n\n- **Screen:** App config (backend)\n- **Feature ID:** `A-SETTINGS`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/main", "host": [ "{{base_url}}" ], "path": [ "main" ] }, "description": "## Purpose\nMain config block.\n\n## Figma screen\n\n- **Screen:** App config (backend)\n- **Feature ID:** `A-SETTINGS`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/main", "host": [ "{{base_url}}" ], "path": [ "main" ] }, "description": "## Purpose\nMain config block.\n\n## Figma screen\n\n- **Screen:** App config (backend)\n- **Feature ID:** `A-SETTINGS`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"fail\",\n \"msg\": \"Class \\\"App\\\\Http\\\\Resources\\\\Api\\\\sliders\\\\SlidersResource\\\" not found\"\n}" } ] }, { "name": "Contact info", "description": "## Purpose\nSupport contacts.\n\n## Figma screen\n\n- **Screen:** Contact channels (static)\n- **Feature ID:** `R-ACC-06`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/contact", "host": [ "{{base_url}}" ], "path": [ "contact" ] }, "description": "## Purpose\nSupport contacts.\n\n## Figma screen\n\n- **Screen:** Contact channels (static)\n- **Feature ID:** `R-ACC-06`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/contact", "host": [ "{{base_url}}" ], "path": [ "contact" ] }, "description": "## Purpose\nSupport contacts.\n\n## Figma screen\n\n- **Screen:** Contact channels (static)\n- **Feature ID:** `R-ACC-06`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": {\n \"header\": {\n \"title\": \" عنوان الصفحة\",\n \"image\": \"http://beeb.test/storage/images/settings/default.png\"\n },\n \"phone\": \"+966555184424\",\n \"email\": \"codebase@gmail.com\"\n }\n}" } ] }, { "name": "Who is us", "description": "## Purpose\nMarketing about snippet.\n\n## Figma screen\n\n- **Screen:** Marketing about\n- **Feature ID:** `R-ACC-07`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/who-is-us", "host": [ "{{base_url}}" ], "path": [ "who-is-us" ] }, "description": "## Purpose\nMarketing about snippet.\n\n## Figma screen\n\n- **Screen:** Marketing about\n- **Feature ID:** `R-ACC-07`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/who-is-us", "host": [ "{{base_url}}" ], "path": [ "who-is-us" ] }, "description": "## Purpose\nMarketing about snippet.\n\n## Figma screen\n\n- **Screen:** Marketing about\n- **Feature ID:** `R-ACC-07`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": {\n \"header\": {\n \"title\": \" عنوان الصفحة\",\n \"image\": \"http://beeb.test/storage/images/settings/default.png\"\n },\n \"who_is_us\": {\n \"content\": \"تكر يهدف إلى تلبية احتياجات المستخدمين في [وصف المجال الذي يستهدفه التطبيق]. يوفر التطبيق مجموعة من الميزات والخدمات المفيدة التي تساعد المستخدمين على القيام بمهامهم بكل سهولة وفاعلية.
\",\n \"image\": \"http://beeb.test/storage/images/pages/1.png\"\n },\n \"other_data\": {\n \"our_vision\": {\n \"content\": \"وصف رؤيتنا
\",\n \"image\": \"http://beeb.test/storage/images/pages/5.png\"\n },\n \"our_goal\": {\n \"content\": \"وصف هدفنا
\",\n \"image\": \"http://beeb.test/storage/images/pages/6.png\"\n },\n \"our_meassage\": {\n \"content\": \"وصف رسالتنا
\",\n \"image\": \"http://beeb.test/storage/images/pages/6.png\"\n }\n }\n }\n}" } ] } ] }, { "name": "02 — Geography", "description": "Countries & cities.", "item": [ { "name": "Countries with cities", "description": "## Purpose\nNested list for registration.\n\n## Figma screen\n\n- **Screen:** Registration — country/city\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/countries-with-cities", "host": [ "{{base_url}}" ], "path": [ "countries-with-cities" ] }, "description": "## Purpose\nNested list for registration.\n\n## Figma screen\n\n- **Screen:** Registration — country/city\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/countries-with-cities", "host": [ "{{base_url}}" ], "path": [ "countries-with-cities" ] }, "description": "## Purpose\nNested list for registration.\n\n## Figma screen\n\n- **Screen:** Registration — country/city\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"السعودية\",\n \"key\": null,\n \"cities\": [\n {\n \"id\": 1,\n \"name\": \"الرياض\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 2,\n \"name\": \"جدة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 3,\n \"name\": \"مكة المكرمة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 4,\n \"name\": \"المدينة المنورة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 5,\n \"name\": \"الدمام\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 6,\n \"name\": \"الخبر\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 7,\n \"name\": \"الطائف\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 8,\n \"name\": \"بريدة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 9,\n \"name\": \"عنيزة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 10,\n \"name\": \"حائل\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 11,\n \"name\": \"تبوك\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 12,\n \"name\": \"أبها\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 13,\n \"name\": \"خميس مشيط\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 14,\n \"name\": \"جازان\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 15,\n \"name\": \"نجران\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 16,\n \"name\": \"ينبع\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 17,\n \"name\": \"الجبيل\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 18,\n \"name\": \"الاحساء\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 19,\n \"name\": \"بيشة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 20,\n \"name\": \"سكاكا\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n }\n ]\n }\n ]\n}" } ] }, { "name": "Countries", "description": "## Purpose\nCountry list.\n\n## Figma screen\n\n- **Screen:** Registration — country picker\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/countries", "host": [ "{{base_url}}" ], "path": [ "countries" ] }, "description": "## Purpose\nCountry list.\n\n## Figma screen\n\n- **Screen:** Registration — country picker\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/countries", "host": [ "{{base_url}}" ], "path": [ "countries" ] }, "description": "## Purpose\nCountry list.\n\n## Figma screen\n\n- **Screen:** Registration — country picker\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"السعودية\",\n \"code\": \"966\",\n \"image\": \"http://beeb.test/defaults//default.png\"\n }\n ]\n}" } ] }, { "name": "Cities", "description": "## Purpose\nCity list.\n\n## Figma screen\n\n- **Screen:** Registration — city picker\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/cities", "host": [ "{{base_url}}" ], "path": [ "cities" ] }, "description": "## Purpose\nCity list.\n\n## Figma screen\n\n- **Screen:** Registration — city picker\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/cities", "host": [ "{{base_url}}" ], "path": [ "cities" ] }, "description": "## Purpose\nCity list.\n\n## Figma screen\n\n- **Screen:** Registration — city picker\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"الرياض\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 2,\n \"name\": \"جدة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 3,\n \"name\": \"مكة المكرمة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 4,\n \"name\": \"المدينة المنورة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 5,\n \"name\": \"الدمام\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 6,\n \"name\": \"الخبر\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 7,\n \"name\": \"الطائف\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 8,\n \"name\": \"بريدة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 9,\n \"name\": \"عنيزة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 10,\n \"name\": \"حائل\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 11,\n \"name\": \"تبوك\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 12,\n \"name\": \"أبها\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 13,\n \"name\": \"خميس مشيط\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 14,\n \"name\": \"جازان\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 15,\n \"name\": \"نجران\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 16,\n \"name\": \"ينبع\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 17,\n \"name\": \"الجبيل\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 18,\n \"name\": \"الاحساء\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 19,\n \"name\": \"بيشة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 20,\n \"name\": \"سكاكا\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n }\n ]\n}" } ] }, { "name": "Cities by country", "description": "## Purpose\nCities for one country.\n\n## Figma screen\n\n- **Screen:** Registration — city picker\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `country_id` | integer | yes | `1` | Path: country ID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/country/{{country_id}}/cities", "host": [ "{{base_url}}" ], "path": [ "country", "{country_id}", "cities" ], "variable": [ { "key": "country_id", "value": "{{country_id}}", "description": "Path parameter" } ] }, "description": "## Purpose\nCities for one country.\n\n## Figma screen\n\n- **Screen:** Registration — city picker\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `country_id` | integer | yes | `1` | Path: country ID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/country/{{country_id}}/cities", "host": [ "{{base_url}}" ], "path": [ "country", "{country_id}", "cities" ], "variable": [ { "key": "country_id", "value": "{{country_id}}", "description": "Path parameter" } ] }, "description": "## Purpose\nCities for one country.\n\n## Figma screen\n\n- **Screen:** Registration — city picker\n- **Feature ID:** `R-AUTH-05`\n\n## Auth\nNone\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `country_id` | integer | yes | `1` | Path: country ID |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"الرياض\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 2,\n \"name\": \"جدة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 3,\n \"name\": \"مكة المكرمة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 4,\n \"name\": \"المدينة المنورة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 5,\n \"name\": \"الدمام\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 6,\n \"name\": \"الخبر\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 7,\n \"name\": \"الطائف\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 8,\n \"name\": \"بريدة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 9,\n \"name\": \"عنيزة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 10,\n \"name\": \"حائل\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 11,\n \"name\": \"تبوك\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 12,\n \"name\": \"أبها\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 13,\n \"name\": \"خميس مشيط\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 14,\n \"name\": \"جازان\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 15,\n \"name\": \"نجران\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 16,\n \"name\": \"ينبع\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 17,\n \"name\": \"الجبيل\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 18,\n \"name\": \"الاحساء\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 19,\n \"name\": \"بيشة\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n },\n {\n \"id\": 20,\n \"name\": \"سكاكا\",\n \"image\": \"http://beeb.test/defaults//default.png\",\n \"country\": \"السعودية\"\n }\n ]\n}" } ] } ] }, { "name": "03 — Static pages", "description": "Legal & marketing.", "item": [ { "name": "About", "description": "## Purpose\nAbout us.\n\n## Figma screen\n\n- **Screen:** About (public web)\n- **Feature ID:** `R-ACC-07`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/about", "host": [ "{{base_url}}" ], "path": [ "about" ] }, "description": "## Purpose\nAbout us.\n\n## Figma screen\n\n- **Screen:** About (public web)\n- **Feature ID:** `R-ACC-07`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/about", "host": [ "{{base_url}}" ], "path": [ "about" ] }, "description": "## Purpose\nAbout us.\n\n## Figma screen\n\n- **Screen:** About (public web)\n- **Feature ID:** `R-ACC-07`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": {\n \"content\": \"تكر يهدف إلى تلبية احتياجات المستخدمين في [وصف المجال الذي يستهدفه التطبيق]. يوفر التطبيق مجموعة من الميزات والخدمات المفيدة التي تساعد المستخدمين على القيام بمهامهم بكل سهولة وفاعلية.
\",\n \"image\": \"http://beeb.test/storage/images/pages/1.png\"\n }\n}" } ] }, { "name": "Terms", "description": "## Purpose\nTerms.\n\n## Figma screen\n\n- **Screen:** Terms (public web)\n- **Feature ID:** `R-AUTH-03`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/terms", "host": [ "{{base_url}}" ], "path": [ "terms" ] }, "description": "## Purpose\nTerms.\n\n## Figma screen\n\n- **Screen:** Terms (public web)\n- **Feature ID:** `R-AUTH-03`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/terms", "host": [ "{{base_url}}" ], "path": [ "terms" ] }, "description": "## Purpose\nTerms.\n\n## Figma screen\n\n- **Screen:** Terms (public web)\n- **Feature ID:** `R-AUTH-03`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": {\n \"content\": \"شروط وأحكام الاستخدام\\r\\n\\r\\n شكرًا لاستخدامك لتطبيق [اسم التطبيق]. يرجى قراءة هذه الشروط والأحكام بعناية قبل استخدام التطبيق. يعتبر استخدامك للتطبيق تأكيدًا منك على قبول هذه الشروط والأحكام والالتزام بها بشكل كامل. إذا كنت لا توافق على هذه الشروط والأحكام، يرجى عدم استخدام التطبيق.\\r\\n \\r\\n الملكية الفكرية: \\r\\n أنت توافق على أن جميع حقوق الملكية الفكرية المتعلقة بتطبيق [اسم التطبيق] ومحتواه (بما في ذلك العلامات التجارية، والشعارات، والنصوص، والصور، والرسومات، والأيقونات، والبرمجيات، والمحتوى الصوتي والبصري الآخر) تعود إلى المطور أو الجهة المملوكة لهذه الحقوق. يُحظر نسخ، توزيع، نقل، عرض عام، بيع، أو استخدام أي من هذه العناصر بأي طريقة تنتهك حقوق الملكية الفكرية للمطور.\\r\\n \\r\\n الاستخدام الشخصي: \\r\\n يتم توفير التطبيق للاستخدام الشخصي فقط. يجب عليك استخدام التطبيق وفقًا للقوانين واللوائح المعمول بها ولأغراض قانونية فقط. يُحظر استخدام التطبيق بطرق تنتهك حقوق الملكية الفكرية للآخرين أو تسبب ضررًا للمطور أو أي طرف آخر.\\r\\n \\r\\n المحتوى المستخدم: \\r\\n عند استخدام التطبيق، قد يطلب منك تقديم بعض المعلومات الشخصية. يجب عليك التأكد من أن المعلومات التي تقدمها صحيحة ومحدّثة. يحظر استخدام معلومات المستخدمين الآخرين بأي طريقة تنتهك خصوصيتهم أو حقوقهم.\\r\\n \\r\\n التحديثات والتعديلات: \\r\\n قد يتم تحديث التطبيق وإجراء تعديلات عليه من وقت لآخر. يجوز للمطور تحديث الشروط والأحكام دون إشعار مسبق. ينبغي عليك مراجعة هذه الشروط والأحكام بشكل منتظم للتأكد من التزامك بها الحالية.\\r\\n \\r\\n الضمان والمسؤولية : \\r\\n يقدم التطبيق \\\"كما هو\\\" دون أي ضمانات صريحة أو ضمنية. يُحظر على المطور أو أي طرف آخر يشارك في إنشاء أو توفير التطبيق أن يكونواستمرارًا في الشروط والأحكام: \\r\\n \\r\\n ويُحظر على المطور أو أي طرف آخر يشارك في إنشاء أو توفير التطبيق أن يكونوا مسؤولين عن أي ضرر مباشر أو غير مباشر ينتج عن استخدامك للتطبيق أو عدم قدرتك على استخدامه، بما في ذلك ولكن لا يقتصر على الأضرار المادية وفقدان البيانات والانقطاع عن الخدمة.\\r\\n \\r\\n ربط المواقع الخارجية: \\r\\n قد يحتوي التطبيق على روابط إلى مواقع الويب الخارجية التي لا تخضع للسيطرة المطور. لا يتحمل المطور مسؤولية المحتوى أو الأداء أو الأمان أو سياسات الخصوصية لتلك المواقع الخارجية. ينبغي عليك أخذ الحيطة والحذر عند الانتقال إلى مواقع الويب الخارجية عن طريق الروابط المقدمة في التطبيق.\\r\\n \\r\\n إنهاء الاستخدام: \\r\\n يحتفظ المطور بحق إنهاء استخدامك للتطبيق في أي وقت وبأي سبب دون إشعار مسبق. قد يتضمن ذلك إنهاء الوصول إلى حسابك وحذف بياناتك المخزنة في التطبيق.\\r\\n \\r\\n التعديلات على الشروط والأحكام: \\r\\n يحتفظ المطور بحق تعديل هذه الشروط والأحكام في أي وقت. ينبغي عليك مراجعة هذه الشروط والأحكام بشكل دوري للتأكد من التزامك بها الحالية.\\r\\n \\r\\n الاتصال: \\r\\n إذا كان لديك أي أسئلة أو استفسارات حول الشروط والأحكام، يرجى الاتصال بنا عبر [ذكر وسيلة الاتصال مثل البريد الإلكتروني أو الهاتف].\\r\\n \\r\\n يرجى ملاحظة أن هذه الشروط والأحكام تعتبر نسخة مترجمة للمساعدة في توفير المعلومات باللغة العربية. ومع ذلك، إذا وجد تباين بين النسخة العربية والنسخة الإنجليزية، يعتبر النص الإنجليزي الأصلي لهذه الشروط والأحكام هو النص الساري والملزم.\",\n \"image\": \"http://beeb.test/storage/images/pages/2.png\"\n }\n}" } ] }, { "name": "Privacy", "description": "## Purpose\nPrivacy.\n\n## Figma screen\n\n- **Screen:** Privacy (public web)\n- **Feature ID:** `R-AUTH-03`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/privacy", "host": [ "{{base_url}}" ], "path": [ "privacy" ] }, "description": "## Purpose\nPrivacy.\n\n## Figma screen\n\n- **Screen:** Privacy (public web)\n- **Feature ID:** `R-AUTH-03`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/privacy", "host": [ "{{base_url}}" ], "path": [ "privacy" ] }, "description": "## Purpose\nPrivacy.\n\n## Figma screen\n\n- **Screen:** Privacy (public web)\n- **Feature ID:** `R-AUTH-03`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": {\n \"content\": \"نحن في [اسم الشركة/التطبيق] نولي أهمية كبيرة لحماية خصوصية المستخدمين لدينا. تحترم هذه السياسة خصوصيتك وتشرح كيفية جمعنا واستخدامنا وحمايتنا للمعلومات التي تقدمها عند استخدام التطبيق. يرجى قراءة هذه السياسة بعناية لفهم ممارساتنا فيما يتعلق بالبيانات الشخصية وكيفية معالجتها. باستخدام التطبيق، فإنك توافق على جمع واستخدام وكشف المعلومات الشخصية وفقًا لهذه السياسة.\\r\\n\\r\\n المعلومات التي نجمعها: \\r\\n عند استخدام التطبيق، قد نقوم بجمع بعض المعلومات الشخصية التي تقدمها بشكل طوعي، مثل الاسم وعنوان البريد الإلكتروني ومعلومات الاتصال الأخرى. قد نقوم أيضًا بتسجيل معلومات غير شخصية، مثل نوع المتصفح ونظام التشغيل وتفاصيل الجهاز، بهدف تحسين خدمتنا وتجربتك.\\r\\n \\r\\n استخدام المعلومات: \\r\\n نستخدم المعلومات التي نجمعها لتخصيص وتحسين تجربتك في التطبيق، وتوفير المحتوى والخدمات المناسبة لك، والتواصل معك بشأن التحديثات والمستجدات، وتحسين خدماتنا وتطويرها، وتوفير الدعم الفني عند الحاجة.\\r\\n \\r\\n حماية المعلومات: \\r\\n نحمي المعلومات الشخصية التي نجمعها من خلال إجراءات أمنية ملائمة للحفاظ على سرية وسلامة البيانات. نحن نتبع معايير الصناعة المعترف بها لحماية المعلومات، ولكن يجب ملاحظة أنه لا يوجد نظام أمان مطلق. لذا، فإننا لا نضمن بشكل صريح أو ضمني سرية المعلومات المرسلة إلينا.\\r\\n \\r\\n مشاركة المعلومات: \\r\\n نحن لا نبيع أو نؤجر أو نتاجر بأي طريقة معلوماتك الشخصية لأطراف ثالثة. قد نقوم بمشاركة بعض المعلومات مع جهات خارجية معتمدة عند الحاجة، مثل مقدمي الخدمات الفنية والشركاء التجاريين، ولكن ذلك يتم وفقًا للقوانين السارية وبما يتوافق مع هذه السياسة.\\r\\n \\r\\n روابط إلى مواقع خارجية: \\r\\n قد يحتستمر السياسة في شرح العديد من النقاط الأخرى المتعلقة بالمعلومات الشخصية والتعامل معها، مثل استخدام ملفات تعريف الارتباط (الكوكيز)، وحقوق الدخول والتصحيح والحذف للمعلومات الشخصية، وحماية الأطفال عبر الإنترنت، وتغييرات في سياسة الخصوصية، والاتصال بنا لأية استفسارات أو مخاوف تتعلق بالخصوصية.\\r\\n \\r\\n يرجى ملاحظة أن هذه النسخة الملخصة لسياسة الخصوصية وتهدف إلى توفير نظرة عامة فقط. إذا كنت ترغب في مزيد من التفاصيل والمعلومات، يرجى الرجوع إلى النسخة الكاملة لسياسة الخصوصية المتاحة في التطبيق أو على موقعنا الإلكتروني.\\r\\n \\r\\n نحن نتعهد بالامتثال لمبادئ حماية الخصوصية وتنظيمات البيانات ذات الصلة في البلدان التي نعمل بها. نحرص على الحفاظ على سرية وأمان المعلومات الشخصية التي تثق بنا إياها.\\r\\n \\r\\n تأكيدًا للتزامنا بحماية الخصوصية، فإن استخدامك المستمر للتطبيق يعتبر موافقة منك على سياسة الخصوصية هذه. إذا كنت لا توافق على أي جزء من هذه السياسة، فيرجى التوقف عن استخدام التطبيق وحذفه من جهازك.\\r\\n \\r\\n تاريخ السريان: [تحديد تاريخ السريان لسياسة الخصوصية]\\r\\n \\r\\n \",\n \"image\": \"http://beeb.test/storage/images/pages/3.png\"\n }\n}" } ] }, { "name": "Ride Terms & Conditions", "description": "## Purpose\nReturns the ride terms & conditions in both Arabic and English, plus a `ride_terms` field resolved to the current request language (via `Lang` header).\n\n## Figma screen\n_Screen mapping not set — add entry in `scripts/postman/figma-screens.php`._\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/ride-terms", "host": [ "{{base_url}}" ], "path": [ "ride-terms" ] }, "description": "## Purpose\nReturns the ride terms & conditions in both Arabic and English, plus a `ride_terms` field resolved to the current request language (via `Lang` header).\n\n## Figma screen\n_Screen mapping not set — add entry in `scripts/postman/figma-screens.php`._\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/ride-terms", "host": [ "{{base_url}}" ], "path": [ "ride-terms" ] }, "description": "## Purpose\nReturns the ride terms & conditions in both Arabic and English, plus a `ride_terms` field resolved to the current request language (via `Lang` header).\n\n## Figma screen\n_Screen mapping not set — add entry in `scripts/postman/figma-screens.php`._\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"ride_terms_ar\": \"شروط وأحكام الرحلة باللغة العربية...\",\n \"ride_terms_en\": \"Ride terms and conditions in English...\",\n \"ride_terms\": \"Ride terms and conditions in English...\"\n }\n}" } ] }, { "name": "Social links", "description": "## Purpose\nSocial URLs.\n\n## Figma screen\n\n- **Screen:** Social links\n- **Feature ID:** `R-ACC-09`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/socials", "host": [ "{{base_url}}" ], "path": [ "socials" ] }, "description": "## Purpose\nSocial URLs.\n\n## Figma screen\n\n- **Screen:** Social links\n- **Feature ID:** `R-ACC-09`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 200", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/socials", "host": [ "{{base_url}}" ], "path": [ "socials" ] }, "description": "## Purpose\nSocial URLs.\n\n## Figma screen\n\n- **Screen:** Social links\n- **Feature ID:** `R-ACC-09`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"العملية تمت بنجاح\",\n \"data\": [\n {\n \"link\": \"https://www.facebook.com\",\n \"name\": \"facebook\",\n \"icon\": \"http://beeb.test/storage/images/socials/default.png\"\n },\n {\n \"link\": \"https://www.instgram.com\",\n \"name\": \"instgram\",\n \"icon\": \"http://beeb.test/storage/images/socials/default.png\"\n },\n {\n \"link\": \"https://www.whatsapp.com\",\n \"name\": \"whatsapp\",\n \"icon\": \"http://beeb.test/storage/images/socials/default.png\"\n }\n ]\n}" } ] }, { "name": "FAQs", "description": "## Purpose\nPaginated FAQs list.\n\n## Figma screen\n\n- **Screen:** FAQs list\n- **Feature ID:** `R-ACC-08`\n\n## Auth\nNone\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `perPage` | integer | no | `15` | Items per page |\n| `type` | string | no | `general` | Filter by type: general (default), trip |\n| `is_paginated` | boolean | no | `true` | Set false to return all items |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"perPage\": \"15\",\n \"type\": \"general\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/faqs?perPage=15&type=general", "host": [ "{{base_url}}" ], "path": [ "faqs" ], "query": [ { "key": "perPage", "value": "15", "description": "", "disabled": false }, { "key": "type", "value": "general", "description": "", "disabled": false } ] }, "description": "## Purpose\nPaginated FAQs list.\n\n## Figma screen\n\n- **Screen:** FAQs list\n- **Feature ID:** `R-ACC-08`\n\n## Auth\nNone\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `perPage` | integer | no | `15` | Items per page |\n| `type` | string | no | `general` | Filter by type: general (default), trip |\n| `is_paginated` | boolean | no | `true` | Set false to return all items |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"perPage\": \"15\",\n \"type\": \"general\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/faqs?perPage=15&type=general", "host": [ "{{base_url}}" ], "path": [ "faqs" ], "query": [ { "key": "perPage", "value": "15", "description": "", "disabled": false }, { "key": "type", "value": "general", "description": "", "disabled": false } ] }, "description": "## Purpose\nPaginated FAQs list.\n\n## Figma screen\n\n- **Screen:** FAQs list\n- **Feature ID:** `R-ACC-08`\n\n## Auth\nNone\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `perPage` | integer | no | `15` | Items per page |\n| `type` | string | no | `general` | Filter by type: general (default), trip |\n| `is_paginated` | boolean | no | `true` | Set false to return all items |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"perPage\": \"15\",\n \"type\": \"general\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": {\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"general\",\n \"question\": \"How do I start a ride?\",\n \"answer\": \"Scan the scooter QR code from the home map.\"\n }\n ],\n \"pagination\": {\n \"total_items\": 1,\n \"count_items\": 1,\n \"per_page\": 15,\n \"total_pages\": 1,\n \"current_page\": 1\n }\n }\n}" } ] } ] }, { "name": "04 — Contact", "description": "Public contact form.", "item": [ { "name": "Contact types", "description": "## Purpose\nList of contact submission types for the contact form.\n\n## Figma screen\n\n- **Screen:** Contact form — type picker\n- **Feature ID:** `R-ACC-06`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/contact/types", "host": [ "{{base_url}}" ], "path": [ "contact", "types" ] }, "description": "## Purpose\nList of contact submission types for the contact form.\n\n## Figma screen\n\n- **Screen:** Contact form — type picker\n- **Feature ID:** `R-ACC-06`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Example — 200 Success", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/contact/types", "host": [ "{{base_url}}" ], "path": [ "contact", "types" ] }, "description": "## Purpose\nList of contact submission types for the contact form.\n\n## Figma screen\n\n- **Screen:** Contact form — type picker\n- **Feature ID:** `R-ACC-06`\n\n## Auth\nNone\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": [\n {\n \"id\": \"trip_issue\",\n \"name\": \"Trip issue\"\n },\n {\n \"id\": \"payment_issue\",\n \"name\": \"Payment issue\"\n },\n {\n \"id\": \"damaged_scooter\",\n \"name\": \"Damaged scooter\"\n },\n {\n \"id\": \"suggestion\",\n \"name\": \"Suggestion\"\n },\n {\n \"id\": \"general_inquiry\",\n \"name\": \"General inquiry\"\n }\n ]\n}" } ] }, { "name": "Store contact message", "description": "## Purpose\nGuest contact form.\n\n## Figma screen\n\n- **Screen:** Contact form (guest)\n- **Feature ID:** `R-ACC-06`\n\n## Auth\nOptional Bearer\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `name` | string | yes | `Ahmed` | |\n| `country_code` | string | yes | `966` | |\n| `phone` | string | yes | `512345678` | |\n| `message` | string | yes | `Need help` | |\n| `type` | string | yes | `general_inquiry` | One of: trip_issue, payment_issue, damaged_scooter, suggestion, general_inquiry (see GET contact/types) |\n\n## Example request\n```json\n{\n \"name\": \"Ahmed\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"message\": \"I need help with the app\",\n \"type\": \"general_inquiry\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "request": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/contact/store", "host": [ "{{base_url}}" ], "path": [ "contact", "store" ] }, "description": "## Purpose\nGuest contact form.\n\n## Figma screen\n\n- **Screen:** Contact form (guest)\n- **Feature ID:** `R-ACC-06`\n\n## Auth\nOptional Bearer\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `name` | string | yes | `Ahmed` | |\n| `country_code` | string | yes | `966` | |\n| `phone` | string | yes | `512345678` | |\n| `message` | string | yes | `Need help` | |\n| `type` | string | yes | `general_inquiry` | One of: trip_issue, payment_issue, damaged_scooter, suggestion, general_inquiry (see GET contact/types) |\n\n## Example request\n```json\n{\n \"name\": \"Ahmed\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"message\": \"I need help with the app\",\n \"type\": \"general_inquiry\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"message\": \"I need help with the app\",\n \"type\": \"general_inquiry\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Live 200", "originalRequest": { "method": "POST", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" }, { "key": "Content-Type", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/contact/store", "host": [ "{{base_url}}" ], "path": [ "contact", "store" ] }, "description": "## Purpose\nGuest contact form.\n\n## Figma screen\n\n- **Screen:** Contact form (guest)\n- **Feature ID:** `R-ACC-06`\n\n## Auth\nOptional Bearer\n\n## Body keys\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `name` | string | yes | `Ahmed` | |\n| `country_code` | string | yes | `966` | |\n| `phone` | string | yes | `512345678` | |\n| `message` | string | yes | `Need help` | |\n| `type` | string | yes | `general_inquiry` | One of: trip_issue, payment_issue, damaged_scooter, suggestion, general_inquiry (see GET contact/types) |\n\n## Example request\n```json\n{\n \"name\": \"Ahmed\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"message\": \"I need help with the app\",\n \"type\": \"general_inquiry\"\n}\n```\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"تمت العملية بنجاح\",\n \"data\": []\n}\n```\n", "body": { "mode": "raw", "raw": "{\n \"name\": \"Ahmed\",\n \"country_code\": \"966\",\n \"phone\": \"512345678\",\n \"message\": \"I need help with the app\",\n \"type\": \"general_inquiry\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"key\": \"success\",\n \"msg\": \"تم ارسال الرسالة بنجاح\"\n}" } ] } ] }, { "name": "05 — Misc", "description": "Other public endpoints.", "item": [ { "name": "Export PDF", "description": "## Purpose\nPDF export.\n\n## Figma screen\n\n- **Screen:** Admin export (backend)\n- **Feature ID:** `A-REPORT`\n\n## Auth\nNone\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `type` | string | no | `` | Export type if applicable |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n", "request": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/export-pdf", "host": [ "{{base_url}}" ], "path": [ "export-pdf" ] }, "description": "## Purpose\nPDF export.\n\n## Figma screen\n\n- **Screen:** Admin export (backend)\n- **Feature ID:** `A-REPORT`\n\n## Auth\nNone\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `type` | string | no | `` | Export type if applicable |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "response": [ { "name": "Live 404", "originalRequest": { "method": "GET", "header": [ { "key": "Lang", "value": "ar", "description": "Locale: ar or en" }, { "key": "Accept", "value": "application/json", "description": "" } ], "url": { "raw": "{{base_url}}/export-pdf", "host": [ "{{base_url}}" ], "path": [ "export-pdf" ] }, "description": "## Purpose\nPDF export.\n\n## Figma screen\n\n- **Screen:** Admin export (backend)\n- **Feature ID:** `A-REPORT`\n\n## Auth\nNone\n\n## Query / path parameters\n\n| Key | Type | Required | Example | Description |\n|-----|------|----------|---------|-------------|\n| `type` | string | no | `` | Export type if applicable |\n\n## Example response\n```json\n{\n \"key\": \"success\",\n \"msg\": \"Operation successful\",\n \"data\": {}\n}\n```\n## Example request\n```json\n{\n \"_note\": \"No body — GET request\"\n}\n```\n\n" }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "" } ], "cookie": [], "body": "{\n \"status\": false,\n \"message\": \"Feature not available\"\n}" } ] } ] } ] } ] }