Skip to main content
HashnodeTosin's Blog

Command Palette

Search for a command to run...

Delvo Api docs

Published
•7 min read
T
Tosin Yusuf

  • register Partner

    • @OA\post (
    • path="/api/partners/register",

    • tags={"Partner"},

    • @OA\RequestBody(

    • @OA\MediaType(
    • mediaType="application/json",
    • @OA\Schema(
    • @OA\Property(
    • type="object",
    • @OA\Property(
    • property="representative_name",
    • type="string"
    • ),
    • @OA\Property(
    • property="representative_phone",
    • type="string"
    • ),
    • @OA\Property(
    • property="representative_email",
    • type="string"
    • ),
    • @OA\Property(
    • property="business_name",
    • type="string"
    • ),
    • @OA\Property(
    • property="business_phone",
    • type="string"
    • ),
    • @OA\Property(
    • property="business_email",
    • type="string"
    • ),
    • @OA\Property(
    • property="no_bikes",
    • type="string"
    • ),
    • @OA\Property(
    • property="password",
    • type="string"
    • ),
    • ),
    • example={
    • "representative_name":"example rep name",
    • "representative_email":"example rep email",
    • "business_name":"example bus name",
    • "business_phone":"example bus phone",
    • "business_email":"example bus email",
    • "no_bikes":"example no-bike",
    • "password":"example password"
    • }
    • )
    • )
    • ),
    • @OA\Response(
    • response=200,
    • description="success",
    • @OA\JsonContent(
    • @OA\Property(property="id", type="number", example=1),
    • @OA\Property(property="representative_name", type="string", example="title"),
    • @OA\Property(property="representative_email", type="string", example="content"),
    • @OA\Property(property="representative_name", type="string", example="title"),
    • @OA\Property(property="business_name", type="string", example="content"),
    • @OA\Property(property="business_phone", type="string", example="title"),
    • @OA\Property(property="business_email", type="string", example="content"),
    • @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
    • @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
    • )
    • )
    • ) */
     /**
 * login Partner
 * @OA\post (
 *     path="/api/partners/login",
 *     tags={"Partner"},

 *     @OA\RequestBody(
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 @OA\Property(
 *                      type="object",
 *                      @OA\Property(
 *                          property="business_email",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="password",
 *                          type="string"
 *                      ),
 *                 ),
 *                 example={
 *                     "business_email":"example rep name",
 *                     "password":"example rep email"
 *                }
 *             )
 *         )
 *      ),
 *      @OA\Response(
 *          response=200,
 *          description="success",
 *          @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="business_email", type="string", example="content"),
 *              @OA\Property(property="password", type="string", example="content")
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *          )
 *      )
 * )
 */




          /**
 * ForgetpasswordBegins
 * @OA\post (
 *     path="/api/partners/create",
 *     tags={"Partner"},

 *     @OA\RequestBody(
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 @OA\Property(
 *                      type="object",
 *                      @OA\Property(
 *                          property="business_email",
 *                          type="string"
 *                      )
 *                 ),
 *                 example={
 *                     "business_email":"example rep name",
 *                }
 *             )
 *         )
 *      ),
 *      @OA\Response(
 *          response=200,
 *          description="success",
 *          @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="business_email", type="string", example="content")
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *          )
 *      )
 * )
 */



               /**
 * Check forgot password token status
 * @OA\get (
 *     path="/api/partners/find/{token}",
 *     tags={"Partner"},
 *     @OA\Parameter(
 *         in="path",
 *         name="token",
 *         required=true,
 *         @OA\Schema(type="string")
 *     ),

 *      @OA\Response(
 *          response=200,
 *          description="success",
 *          @OA\JsonContent(
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *          )
 *      )
 * )
 */


               /**
 * Complete updating user password
 * @OA\put (
 *     path="/api/partners/reset",
 *     tags={"Partner"},

 *     @OA\RequestBody(
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 @OA\Property(
 *                      type="object",
 *                      @OA\Property(
 *                          property="business_email",
 *                          type="string"
 *                      ),
  *                      @OA\Property(
 *                          property="password",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="token",
 *                          type="string"
 *                      )
 *                 ),
 *                 example={
 *                     "business_email":"example rep name",
 *                      "password":"example password",
 *                      "token":"example token",
 *                }
 *             )
 *         )
 *      ),
 *      @OA\Response(
 *          response=200,
 *          description="success",
 *          @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="business_email", type="string", example="content")
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *          )
 *      )
 * )
 */


/**
 * Create Bike
 * @OA\Post (
 *     path="/api/partners/bike_setup",
 *     tags={"Partner"},
 *     @OA\RequestBody(
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 @OA\Property(
 *                      type="object",
 *                      @OA\Property(
 *                          property="bike_model",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="bike_type",
 *                          type="string"
 *                      ),
 *                       @OA\Property(
 *                          property="bike_power",
 *                          type="integer"
 *                      ),
 *                      @OA\Property(
 *                          property="images",
 *                          type="string"
 *                      )
 *                 ),
 *                 example={
 *                     "bike_model":"example A4",
 *                     "bike_type":"example honda bike"
 *                     "bike_power":"example 5",
 *                     "images":"example images.jpg"
 *                }
 *             )
 *         )
 *      ),
 *      @OA\Response(
 *          response=200,
 *          description="success",
 *          @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="bike_model", type="string", example="title"),
 *              @OA\Property(property="bike_type", type="string", example="content"),
 * *              @OA\Property(property="bike_power", type="integer", example="title"),
 *              @OA\Property(property="images", type="string", example="content"),
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *          )
 *      ),
 *      @OA\Response(
 *          response=400,
 *          description="invalid",
 *          @OA\JsonContent(
 *              @OA\Property(property="msg", type="string", example="fail"),
 *          )
 *      )
 * )
 */


 /**
 * Create Rider
 * @OA\Post (
 *     path="/api/partners/create_rider",
 *     tags={"Partner"},
 *     @OA\RequestBody(
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 @OA\Property(
 *                      type="object",
 *                      @OA\Property(
 *                          property="riderName",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="riderEmail",
 *                          type="string"
 *                      ),
 *                       @OA\Property(
 *                          property="password",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="riderBike",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="riderPhone",
 *                          type="string"
 *                      )
 *                 ),
 *                 example={
 *                     "riderName":"example rider name",
 *                     "riderEmail":"example partner@gmail.com"
 *                     "password":"example partner password",
 *                     "riderBike":"example honda bike",
 *                     "riderPhone":"example 08090506340"
 *                }
 *             )
 *         )
 *      ),
 *      @OA\Response(
 *          response=200,
 *          description="success",
 *          @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="riderName", type="string", example="title"),
 *              @OA\Property(property="riderEmail", type="string", example="content"),
 * *              @OA\Property(property="bike_power", type="integer", example="title"),
 *              @OA\Property(property="password", type="string", example="content"),
 *              @OA\Property(property="riderBike", type="string", example="content"),
 *              @OA\Property(property="riderPhone", type="string", example="content"),
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *          )
 *      ),
 *      @OA\Response(
 *          response=400,
 *          description="invalid",
 *          @OA\JsonContent(
 *              @OA\Property(property="msg", type="string", example="fail"),
 *          )
 *      )
 * )
 */




     /**
 * Update Partner
 * @OA\Put (
 *     path="/api/partners/update_account",
 *     tags={"Partner"},

 *     @OA\RequestBody(
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 @OA\Property(
 *                      type="object",
 *                      @OA\Property(
 *                          property="representative_name",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="representative_phone",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="representative_email",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="business_name",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="business_phone",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="business_email",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="no_bikes",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="password",
 *                          type="string"
 *                      ),
 *                 ),
 *                 example={
 *                     "representative_name":"example rep name",
 *                     "representative_email":"example rep email",
 *                      "business_name":"example bus name",
 *                     "business_phone":"example bus phone",
 *                      "business_email":"example bus email",
 *                     "no_bikes":"example no-bike",
 *                      "password":"example password"
 *                }
 *             )
 *         )
 *      ),
 *      @OA\Response(
 *          response=200,
 *          description="success",
 *          @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="representative_name", type="string", example="title"),
 *              @OA\Property(property="representative_email", type="string", example="content"),
 *              @OA\Property(property="representative_name", type="string", example="title"),
 *              @OA\Property(property="business_name", type="string", example="content"),
 *              @OA\Property(property="business_phone", type="string", example="title"),
 *              @OA\Property(property="business_email", type="string", example="content"),
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *          )
 *      )
 * )
 */


     /**
 * Get Partner's bike
 * @OA\Get (
 *     path="/api/partners/all_bike",
 *     tags={"Bike"},
 *     @OA\Response(
 *         response=200,
 *         description="success",
 *         @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *         )
 *     )
 * )
 */


              /**
 * Get a Partner's bike
 * @OA\Get (
 *     path="/api/partners/show_bike/{id}",
 *     tags={"Bike"},
 *     @OA\Parameter(
 *         in="path",
 *         name="id",
 *         required=true,
 *         @OA\Schema(type="string")
 *     ),
 *     @OA\Response(
 *         response=200,
 *         description="success",
 *         @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *         )
 *     )
 * )
 */


          /**
 * lock Partner's acc
 * @OA\post (
 *     path="/api/partners/lock_partner",
 *     tags={"partner"},
 *     @OA\Response(
 *         response=200,
 *         description="success",
 *         @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *         )
 *     )
 * )
 */


               /**
 * disable Partner's acc
 * @OA\post (
 *     path="/api/partners/deactivate_account",
 *     tags={"partner"},
 *     @OA\Response(
 *         response=200,
 *         description="success",
 *         @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *         )
 *     )
 * )
 */


               /*



         /**
 * Disable a rider
 * @OA\post (
 *     path="/api/partners/disable_rider/{id}",
 *     tags={"rider"},
 *     @OA\Parameter(
 *         in="path",
 *         name="id",
 *         required=true,
 *         @OA\Schema(type="string")
 *     ),
 *     @OA\Response(
 *         response=200,
 *         description="success",
 *         @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *         )
 *     )
 * )
 */



         /**
 * Reset rider password
 * @OA\put (
 *     path="/api/partners/Reset_rider_password/{id}",
 *     tags={"rider"},
 *     @OA\Parameter(
 *         in="path",
 *         name="id",
 *         required=true,
 *         @OA\Schema(type="string")
 *     ),
 *     @OA\RequestBody(
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 @OA\Property(
 *                      type="object",
 *                      @OA\Property(
 *                          property="riderName",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="reason",
 *                          type="string"
 *                      )
 *                 ),
 *                 example={
 *                     "riderName":"example rider name",
 *                     "reason":"example partner@gmail.com"
 *                }
 *             )
 *         )
 *      ),
 *     @OA\Response(
 *         response=200,
 *         description="success",
 *         @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *         )
 *     )
 * )
 */


     /**
 * Change partner password 
 * @OA\Put (
 *     path="/api/partners/change_password",
 *     tags={"Partner"},
 *     @OA\RequestBody(
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 @OA\Property(
 *                      type="object",
 *                      @OA\Property(
 *                          property="old_password",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="password",
 *                          type="string"
 *                      ),
 *                      @OA\Property(
 *                          property="confirm_password",
 *                          type="string"
 *                      )
 *                 ),
 *                 example={
 *                     "old_password":"example old password",
 *                     "password":"example new password"
 *                }
 *             )
 *         )
 *      ),
 *     @OA\Response(
 *         response=200,
 *         description="success",
 *         @OA\JsonContent(
 *              @OA\Property(property="id", type="number", example=1),
 *              @OA\Property(property="updated_at", type="string", example="2021-12-11T09:25:53.000000Z"),
 *              @OA\Property(property="created_at", type="string", example="2021-12-11T09:25:53.000000Z")
 *         )
 *     )
 */

Comments

Join the discussion

No comments yet. Be the first to comment.

More from this blog

Tosin's Blog

2 posts