mirror of
				https://github.com/invoiceninja/invoiceninja.git
				synced 2025-10-31 05:37:33 -04:00 
			
		
		
		
	
		
			
				
	
	
		
			600 lines
		
	
	
		
			23 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			600 lines
		
	
	
		
			23 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| <?php
 | |
| 
 | |
| /**
 | |
|  * Invoice Ninja (https://invoiceninja.com)
 | |
|  *
 | |
|  * @link https://github.com/invoiceninja/invoiceninja source repository
 | |
|  *
 | |
|  * @copyright Copyright (c) 2020. Invoice Ninja LLC (https://invoiceninja.com)
 | |
|  *
 | |
|  * @license https://opensource.org/licenses/AAL
 | |
|  */
 | |
| 
 | |
| namespace App\Http\Controllers;
 | |
| 
 | |
| use App\Factory\SubscriptionFactory;
 | |
| use App\Filters\SubscriptionFilters;
 | |
| use App\Http\Requests\Subscription\CreateSubscriptionRequest;
 | |
| use App\Http\Requests\Subscription\DestroySubscriptionRequest;
 | |
| use App\Http\Requests\Subscription\EditSubscriptionRequest;
 | |
| use App\Http\Requests\Subscription\ShowSubscriptionRequest;
 | |
| use App\Http\Requests\Subscription\StoreSubscriptionRequest;
 | |
| use App\Http\Requests\Subscription\UpdateSubscriptionRequest;
 | |
| use App\Models\Subscription;
 | |
| use App\Repositories\BaseRepository;
 | |
| use App\Transformers\SubscriptionTransformer;
 | |
| use App\Utils\Traits\MakesHash;
 | |
| use Illuminate\Http\Request;
 | |
| 
 | |
| class SubscriptionController extends BaseController
 | |
| {
 | |
|     use MakesHash;
 | |
| 
 | |
|     protected $entity_type = Subscription::class;
 | |
| 
 | |
|     protected $entity_transformer = SubscriptionTransformer::class;
 | |
| 
 | |
|     public $base_repo;
 | |
| 
 | |
|     public function __construct(BaseRepository $base_repo)
 | |
|     {
 | |
|         parent::__construct();
 | |
| 
 | |
|         $this->base_repo = $base_repo;
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      *      @OA\Get(
 | |
|      *      path="/api/v1/subscriptions",
 | |
|      *      operationId="getSubscriptions",
 | |
|      *      tags={"subscriptions"},
 | |
|      *      summary="Gets a list of subscriptions",
 | |
|      *      description="Lists subscriptions, search and filters allow fine grained lists to be generated.
 | |
|      *
 | |
|      *      Query parameters can be added to performed more fine grained filtering of the subscriptions, these are handled by the SubscriptionFilters class which defines the methods available",
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/include"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/index"),
 | |
|      *      @OA\Response(
 | |
|      *          response=200,
 | |
|      *          description="A list of subscriptions",
 | |
|      *          @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
 | |
|      *          @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
 | |
|      *          @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/Subscription"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *          response=422,
 | |
|      *          description="Validation error",
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/ValidationError"),
 | |
| 
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *           response="default",
 | |
|      *           description="Unexpected Error",
 | |
|      *           @OA\JsonContent(ref="#/components/schemas/Error"),
 | |
|      *       ),
 | |
|      *     )
 | |
|      *
 | |
|      */
 | |
|     public function index(SubscriptionFilters $filters)
 | |
|     {
 | |
|         $subscriptions = Subscription::filter($filters);
 | |
| 
 | |
|         return $this->listResponse($subscriptions);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Display the specified resource.
 | |
|      *
 | |
|      * @param  int  $id
 | |
|      * @return \Illuminate\Http\Response
 | |
|      *
 | |
|      *
 | |
|      * @OA\Get(
 | |
|      *      path="/api/v1/subscriptions/{id}",
 | |
|      *      operationId="showSubscription",
 | |
|      *      tags={"subscriptions"},
 | |
|      *      summary="Shows a subscription",
 | |
|      *      description="Displays a subscription by id",
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/include"),
 | |
|      *      @OA\Parameter(
 | |
|      *          name="id",
 | |
|      *          in="path",
 | |
|      *          description="The Subscription Hashed ID",
 | |
|      *          example="D2J234DFA",
 | |
|      *          required=true,
 | |
|      *          @OA\Schema(
 | |
|      *              type="string",
 | |
|      *              format="string",
 | |
|      *          ),
 | |
|      *      ),
 | |
|      *      @OA\Response(
 | |
|      *          response=200,
 | |
|      *          description="Returns the subscription object",
 | |
|      *          @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
 | |
|      *          @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
 | |
|      *          @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/Subscription"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *          response=422,
 | |
|      *          description="Validation error",
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/ValidationError"),
 | |
|      *
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *           response="default",
 | |
|      *           description="Unexpected Error",
 | |
|      *           @OA\JsonContent(ref="#/components/schemas/Error"),
 | |
|      *       ),
 | |
|      *     )
 | |
|      *
 | |
|      */
 | |
|     public function show(ShowSubscriptionRequest $request, Subscription $subscription)
 | |
|     {
 | |
|         return $this->itemResponse($subscription);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Show the form for editing the specified resource.
 | |
|      *
 | |
|      * @param  int  $id
 | |
|      * @return \Illuminate\Http\Response
 | |
|      *
 | |
|      *
 | |
|      * @OA\Get(
 | |
|      *      path="/api/v1/subscriptions/{id}/edit",
 | |
|      *      operationId="editSubscription",
 | |
|      *      tags={"subscriptions"},
 | |
|      *      summary="Shows a subscription for editting",
 | |
|      *      description="Displays a subscription by id",
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/include"),
 | |
|      *      @OA\Parameter(
 | |
|      *          name="id",
 | |
|      *          in="path",
 | |
|      *          description="The Subscription Hashed ID",
 | |
|      *          example="D2J234DFA",
 | |
|      *          required=true,
 | |
|      *          @OA\Schema(
 | |
|      *              type="string",
 | |
|      *              format="string",
 | |
|      *          ),
 | |
|      *      ),
 | |
|      *      @OA\Response(
 | |
|      *          response=200,
 | |
|      *          description="Returns the subscription object",
 | |
|      *          @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
 | |
|      *          @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
 | |
|      *          @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/Subscription"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *          response=422,
 | |
|      *          description="Validation error",
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/ValidationError"),
 | |
|      *
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *           response="default",
 | |
|      *           description="Unexpected Error",
 | |
|      *           @OA\JsonContent(ref="#/components/schemas/Error"),
 | |
|      *       ),
 | |
|      *     )
 | |
|      *
 | |
|      */
 | |
|     public function edit(EditSubscriptionRequest $request, Subscription $subscription)
 | |
|     {
 | |
|         return $this->itemResponse($subscription);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Update the specified resource in storage.
 | |
|      *
 | |
|      * @param  \Illuminate\Http\Request  $request
 | |
|      * @param  App\Models\Subscription $subscription
 | |
|      * @return \Illuminate\Http\Response
 | |
|      *
 | |
|      *
 | |
|      *
 | |
|      * @OA\Put(
 | |
|      *      path="/api/v1/subscriptions/{id}",
 | |
|      *      operationId="updateSubscription",
 | |
|      *      tags={"subscriptions"},
 | |
|      *      summary="Updates a subscription",
 | |
|      *      description="Handles the updating of a subscription by id",
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/include"),
 | |
|      *      @OA\Parameter(
 | |
|      *          name="id",
 | |
|      *          in="path",
 | |
|      *          description="The Subscription Hashed ID",
 | |
|      *          example="D2J234DFA",
 | |
|      *          required=true,
 | |
|      *          @OA\Schema(
 | |
|      *              type="string",
 | |
|      *              format="string",
 | |
|      *          ),
 | |
|      *      ),
 | |
|      *      @OA\Response(
 | |
|      *          response=200,
 | |
|      *          description="Returns the subscription object",
 | |
|      *          @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
 | |
|      *          @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
 | |
|      *          @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/Subscription"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *          response=422,
 | |
|      *          description="Validation error",
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/ValidationError"),
 | |
|      *
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *           response="default",
 | |
|      *           description="Unexpected Error",
 | |
|      *           @OA\JsonContent(ref="#/components/schemas/Error"),
 | |
|      *       ),
 | |
|      *     )
 | |
|      *
 | |
|      */
 | |
|     public function update(UpdateSubscriptionRequest $request, Subscription $subscription)
 | |
|     {
 | |
|         if ($request->entityIsDeleted($subscription)) {
 | |
|             return $request->disallowUpdate();
 | |
|         }
 | |
| 
 | |
|         $subscription->fill($request->all());
 | |
|         $subscription->save();
 | |
| 
 | |
|         return $this->itemResponse($subscription);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Show the form for creating a new resource.
 | |
|      *
 | |
|      * @return \Illuminate\Http\Response
 | |
|      *
 | |
|      *
 | |
|      *
 | |
|      * @OA\Get(
 | |
|      *      path="/api/v1/subscriptions/create",
 | |
|      *      operationId="getSubscriptionsCreate",
 | |
|      *      tags={"subscriptions"},
 | |
|      *      summary="Gets a new blank subscription object",
 | |
|      *      description="Returns a blank object with default values",
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/include"),
 | |
|      *      @OA\Response(
 | |
|      *          response=200,
 | |
|      *          description="A blank subscription object",
 | |
|      *          @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
 | |
|      *          @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
 | |
|      *          @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/Subscription"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *          response=422,
 | |
|      *          description="Validation error",
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/ValidationError"),
 | |
|      *
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *           response="default",
 | |
|      *           description="Unexpected Error",
 | |
|      *           @OA\JsonContent(ref="#/components/schemas/Error"),
 | |
|      *       ),
 | |
|      *     )
 | |
|      *
 | |
|      */
 | |
|     public function create(CreateSubscriptionRequest $request)
 | |
|     {
 | |
|         $subscription = SubscriptionFactory::create(auth()->user()->company()->id, auth()->user()->id);
 | |
|         $subscription->fill($request->all());
 | |
|         $subscription->save();
 | |
|         
 | |
|         return $this->itemResponse($subscription);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Store a newly created resource in storage.
 | |
|      *
 | |
|      * @param  \Illuminate\Http\Request  $request
 | |
|      * @return \Illuminate\Http\Response
 | |
|      *
 | |
|      *
 | |
|      *
 | |
|      * @OA\Post(
 | |
|      *      path="/api/v1/subscriptions",
 | |
|      *      operationId="storeSubscription",
 | |
|      *      tags={"subscriptions"},
 | |
|      *      summary="Adds a subscription",
 | |
|      *      description="Adds an subscription to a company",
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/include"),
 | |
|      *      @OA\Response(
 | |
|      *          response=200,
 | |
|      *          description="Returns the saved subscription object",
 | |
|      *          @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
 | |
|      *          @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
 | |
|      *          @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/Subscription"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *          response=422,
 | |
|      *          description="Validation error",
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/ValidationError"),
 | |
|      *
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *           response="default",
 | |
|      *           description="Unexpected Error",
 | |
|      *           @OA\JsonContent(ref="#/components/schemas/Error"),
 | |
|      *       ),
 | |
|      *     )
 | |
|      *
 | |
|      */
 | |
|     public function store(StoreSubscriptionRequest $request)
 | |
|     {
 | |
|         $subscription = SubscriptionFactory::create(auth()->user()->company()->id, auth()->user()->id);
 | |
|         $subscription->fill($request->all());
 | |
|         $subscription->save();
 | |
| 
 | |
|         return $this->itemResponse($subscription);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Remove the specified resource from storage.
 | |
|      *
 | |
|      * @param  int  $id
 | |
|      * @return \Illuminate\Http\Response
 | |
|      *
 | |
|      *
 | |
|      * @OA\Delete(
 | |
|      *      path="/api/v1/subscriptions/{id}",
 | |
|      *      operationId="deleteSubscription",
 | |
|      *      tags={"subscriptions"},
 | |
|      *      summary="Deletes a subscription",
 | |
|      *      description="Handles the deletion of a subscription by id",
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/include"),
 | |
|      *      @OA\Parameter(
 | |
|      *          name="id",
 | |
|      *          in="path",
 | |
|      *          description="The Subscription Hashed ID",
 | |
|      *          example="D2J234DFA",
 | |
|      *          required=true,
 | |
|      *          @OA\Schema(
 | |
|      *              type="string",
 | |
|      *              format="string",
 | |
|      *          ),
 | |
|      *      ),
 | |
|      *      @OA\Response(
 | |
|      *          response=200,
 | |
|      *          description="Returns a HTTP status",
 | |
|      *          @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
 | |
|      *          @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
 | |
|      *          @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *          response=422,
 | |
|      *          description="Validation error",
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/ValidationError"),
 | |
|      *
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *           response="default",
 | |
|      *           description="Unexpected Error",
 | |
|      *           @OA\JsonContent(ref="#/components/schemas/Error"),
 | |
|      *       ),
 | |
|      *     )
 | |
|      *
 | |
|      */
 | |
|     public function destroy(DestroySubscriptionRequest $request, Subscription $subscription)
 | |
|     {
 | |
|         //may not need these destroy routes as we are using actions to 'archive/delete'
 | |
|         $subscription->delete();
 | |
| 
 | |
|         return $this->itemResponse($subscription);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Perform bulk actions on the list view
 | |
|      *
 | |
|      * @param BulkSubscriptionRequest $request
 | |
|      * @return \Illuminate\Http\Response
 | |
|      *
 | |
|      *
 | |
|      * @OA\Post(
 | |
|      *      path="/api/v1/subscriptions/bulk",
 | |
|      *      operationId="bulkSubscriptions",
 | |
|      *      tags={"subscriptions"},
 | |
|      *      summary="Performs bulk actions on an array of subscriptions",
 | |
|      *      description="",
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/index"),
 | |
|      *      @OA\RequestBody(
 | |
|      *         description="User credentials",
 | |
|      *         required=true,
 | |
|      *         @OA\MediaType(
 | |
|      *             mediaType="application/json",
 | |
|      *             @OA\Schema(
 | |
|      *                 type="array",
 | |
|      *                 @OA\Items(
 | |
|      *                     type="integer",
 | |
|      *                     description="Array of hashed IDs to be bulk 'actioned",
 | |
|      *                     example="[0,1,2,3]",
 | |
|      *                 ),
 | |
|      *             )
 | |
|      *         )
 | |
|      *     ),
 | |
|      *      @OA\Response(
 | |
|      *          response=200,
 | |
|      *          description="The Subscription User response",
 | |
|      *          @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
 | |
|      *          @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
 | |
|      *          @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/Subscription"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *          response=422,
 | |
|      *          description="Validation error",
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/ValidationError"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *           response="default",
 | |
|      *           description="Unexpected Error",
 | |
|      *           @OA\JsonContent(ref="#/components/schemas/Error"),
 | |
|      *       ),
 | |
|      *     )
 | |
|      */
 | |
|     public function bulk()
 | |
|     {
 | |
|         $action = request()->input('action');
 | |
| 
 | |
|         $ids = request()->input('ids');
 | |
|         $subscriptions = Subscription::withTrashed()->find($this->transformKeys($ids));
 | |
| 
 | |
|         $subscriptions->each(function ($subscription, $key) use ($action) {
 | |
|             if (auth()->user()->can('edit', $subscription)) {
 | |
|                 $this->base_repo->{$action}($subscription);
 | |
|             }
 | |
|         });
 | |
| 
 | |
|         return $this->listResponse(Subscription::withTrashed()->whereIn('id', $this->transformKeys($ids)));
 | |
|     }
 | |
| 
 | |
| 
 | |
|     /**
 | |
|      * Store a newly created resource in storage.
 | |
|      *
 | |
|      * @OA\Post(
 | |
|      *      path="/api/v1/hooks",
 | |
|      *      operationId="storeHook",
 | |
|      *      tags={"hooks"},
 | |
|      *      summary="Adds a hook",
 | |
|      *      description="Adds a hooks to a company",
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/include"),
 | |
|      *      @OA\Response(
 | |
|      *          response=200,
 | |
|      *          description="Returns the saved hooks object",
 | |
|      *          @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
 | |
|      *          @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
 | |
|      *          @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/Subscription"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *          response=422,
 | |
|      *          description="Validation error",
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/ValidationError"),
 | |
|      *
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *           response="default",
 | |
|      *           description="Unexpected Error",
 | |
|      *           @OA\JsonContent(ref="#/components/schemas/Error"),
 | |
|      *       ),
 | |
|      *     )
 | |
|      *
 | |
|      */
 | |
|     public function subscribe(StoreSubscriptionRequest $request)
 | |
|     {
 | |
|         $event_id = $request->input('event_id');
 | |
|         $target_url = $request->input('target_url');
 | |
| 
 | |
|         if (!in_array($event_id, Subscription::$valid_events)) {
 | |
|             return response()->json("Invalid event", 400);
 | |
|         }
 | |
| 
 | |
|         $subscription = new Subscription;
 | |
|         $subscription->company_id = auth()->user()->company()->id;
 | |
|         $subscription->user_id = auth()->user()->id;
 | |
|         $subscription->event_id = $event_id;
 | |
|         $subscription->target_url = $target_url;
 | |
|         $subscription->save();
 | |
| 
 | |
|         if (!$subscription->id) {
 | |
|             return response()->json('Failed to create subscription', 400);
 | |
|         }
 | |
| 
 | |
|         return $this->itemResponse($subscription);
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Remove the specified resource from storage.
 | |
|      *
 | |
|      * @param  int  $id
 | |
|      * @return \Illuminate\Http\Response
 | |
|      *
 | |
|      *
 | |
|      * @OA\Delete(
 | |
|      *      path="/api/v1/hooks/{subscription_id}",
 | |
|      *      operationId="deleteHook",
 | |
|      *      tags={"hooks"},
 | |
|      *      summary="Deletes a hook",
 | |
|      *      description="Handles the deletion of a hook by id",
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
 | |
|      *      @OA\Parameter(ref="#/components/parameters/include"),
 | |
|      *      @OA\Parameter(
 | |
|      *          name="subscription_id",
 | |
|      *          in="path",
 | |
|      *          description="The Subscription Hashed ID",
 | |
|      *          example="D2J234DFA",
 | |
|      *          required=true,
 | |
|      *          @OA\Schema(
 | |
|      *              type="string",
 | |
|      *              format="string",
 | |
|      *          ),
 | |
|      *      ),
 | |
|      *      @OA\Response(
 | |
|      *          response=200,
 | |
|      *          description="Returns a HTTP status",
 | |
|      *          @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
 | |
|      *          @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
 | |
|      *          @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *          response=422,
 | |
|      *          description="Validation error",
 | |
|      *          @OA\JsonContent(ref="#/components/schemas/ValidationError"),
 | |
|      *
 | |
|      *       ),
 | |
|      *       @OA\Response(
 | |
|      *           response="default",
 | |
|      *           description="Unexpected Error",
 | |
|      *           @OA\JsonContent(ref="#/components/schemas/Error"),
 | |
|      *       ),
 | |
|      *     )
 | |
|      *
 | |
|      */
 | |
|     public function unsubscribe(DestroySubscriptionRequest $request, Subscription $subscription)
 | |
|     {
 | |
|         $subscription->delete();
 | |
| 
 | |
|         return $this->itemResponse($subscription);
 | |
|     }
 | |
| }
 |