mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 21:22:58 +01:00
102 lines
3.4 KiB
PHP
102 lines
3.4 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\Http\Requests\Email\SendEmailRequest;
|
||
|
use App\Utils\Traits\MakesHash;
|
||
|
|
||
|
class EmailController extends BaseController
|
||
|
{
|
||
|
use MakesHash;
|
||
|
|
||
|
public function __construct()
|
||
|
{
|
||
|
parent::__construct();
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns a template filled with entity variables
|
||
|
*
|
||
|
* @return \Illuminate\Http\Response
|
||
|
*
|
||
|
* @OA\Post(
|
||
|
* path="/api/v1/emails",
|
||
|
* operationId="sendEmailTemplate",
|
||
|
* tags={"emails"},
|
||
|
* summary="Sends an email for an entity",
|
||
|
* description="Sends an email for an entity",
|
||
|
* @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
|
||
|
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
|
||
|
* @OA\RequestBody(
|
||
|
* description="The template subject and body",
|
||
|
* required=true,
|
||
|
* @OA\MediaType(
|
||
|
* mediaType="application/json",
|
||
|
* @OA\Schema(
|
||
|
* type="object",
|
||
|
* @OA\Property(
|
||
|
* property="subject",
|
||
|
* description="The email subject",
|
||
|
* type="string",
|
||
|
* ),
|
||
|
* @OA\Property(
|
||
|
* property="body",
|
||
|
* description="The email body",
|
||
|
* type="string",
|
||
|
* ),
|
||
|
* @OA\Property(
|
||
|
* property="entity",
|
||
|
* description="The entity name",
|
||
|
* type="string",
|
||
|
* ),
|
||
|
* @OA\Property(
|
||
|
* property="entity_id",
|
||
|
* description="The entity_id",
|
||
|
* type="string",
|
||
|
* ),
|
||
|
* @OA\Property(
|
||
|
* property="template",
|
||
|
* description="The template required",
|
||
|
* type="string",
|
||
|
* ),
|
||
|
* )
|
||
|
* )
|
||
|
* ),
|
||
|
* @OA\Response(
|
||
|
* response=200,
|
||
|
* description="success",
|
||
|
* @OA\Header(header="X-API-Version", ref="#/components/headers/X-API-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/Template"),
|
||
|
* ),
|
||
|
* @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 send(SendEmailRequest $request)
|
||
|
{
|
||
|
$data = [];
|
||
|
|
||
|
return response()->json($data, 200);
|
||
|
}
|
||
|
}
|