From 770f0763f40557d1f9d7b001850a377c54123bc1 Mon Sep 17 00:00:00 2001
From: David Bomba <turbo124@gmail.com>
Date: Sun, 19 Jan 2020 11:19:10 +1000
Subject: [PATCH] OpenAPI documentation for Payments. (#3223)

* Working on API docs for payments

* Fixes for OpenAPI documentation

* Fix for conditionals in invoice calculator
---
 app/Helpers/Invoice/InvoiceItemSum.php        |  2 +-
 .../Invoice/InvoiceItemSumInclusive.php       |  2 +-
 .../OpenAPI/CreditPaymentableSchema.php       | 10 ++++++
 .../OpenAPI/InvoicePaymentableSchema.php      | 10 ++++++
 .../Controllers/OpenAPI/PaymentSchema.php     | 18 +++++++++++
 .../Controllers/OpenAPI/PaymentableSchema.php | 14 +++++++++
 app/Http/Controllers/PaymentController.php    | 31 +------------------
 app/Transformers/PaymentableTransformer.php   |  1 +
 8 files changed, 56 insertions(+), 32 deletions(-)
 create mode 100644 app/Http/Controllers/OpenAPI/CreditPaymentableSchema.php
 create mode 100644 app/Http/Controllers/OpenAPI/InvoicePaymentableSchema.php
 create mode 100644 app/Http/Controllers/OpenAPI/PaymentableSchema.php

diff --git a/app/Helpers/Invoice/InvoiceItemSum.php b/app/Helpers/Invoice/InvoiceItemSum.php
index df8e3358fb36..693cc4b4d722 100644
--- a/app/Helpers/Invoice/InvoiceItemSum.php
+++ b/app/Helpers/Invoice/InvoiceItemSum.php
@@ -58,7 +58,7 @@ class InvoiceItemSum
 
     public function process()
     {
-        if (!$this->invoice->line_items || !isset($this->invoice->line_items) || count($this->invoice->line_items) == 0) {
+        if (!$this->invoice->line_items || !isset($this->invoice->line_items) || !is_array($this->invoice->line_items) || count($this->invoice->line_items) == 0) {
             $this->items = [];
             return $this;
         }
diff --git a/app/Helpers/Invoice/InvoiceItemSumInclusive.php b/app/Helpers/Invoice/InvoiceItemSumInclusive.php
index 8adc3a9a2470..2621387cd058 100644
--- a/app/Helpers/Invoice/InvoiceItemSumInclusive.php
+++ b/app/Helpers/Invoice/InvoiceItemSumInclusive.php
@@ -57,7 +57,7 @@ class InvoiceItemSumInclusive
 
     public function process()
     {
-        if (!$this->invoice->line_items || count($this->invoice->line_items) == 0) {
+        if (!$this->invoice->line_items || !is_array($this->invoice->line_items) || count($this->invoice->line_items) == 0) {
             $this->items = [];
             return $this;
         }
diff --git a/app/Http/Controllers/OpenAPI/CreditPaymentableSchema.php b/app/Http/Controllers/OpenAPI/CreditPaymentableSchema.php
new file mode 100644
index 000000000000..2b8519d377f3
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/CreditPaymentableSchema.php
@@ -0,0 +1,10 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="CreditPaymentable",
+ *   type="object",
+ *       @OA\Property(property="credit_id", type="string", example="Opnel5aKBz", description="______"),
+ *       @OA\Property(property="amount", type="string", example="2", description="______"),
+ *       
+ * )
+ */
diff --git a/app/Http/Controllers/OpenAPI/InvoicePaymentableSchema.php b/app/Http/Controllers/OpenAPI/InvoicePaymentableSchema.php
new file mode 100644
index 000000000000..7e2789e31cbe
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/InvoicePaymentableSchema.php
@@ -0,0 +1,10 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="InvoicePaymentable",
+ *   type="object",
+ *       @OA\Property(property="invoice_id", type="string", example="Opnel5aKBz", description="______"),
+ *       @OA\Property(property="amount", type="string", example="2", description="______"),
+ *       
+ * )
+ */
diff --git a/app/Http/Controllers/OpenAPI/PaymentSchema.php b/app/Http/Controllers/OpenAPI/PaymentSchema.php
index 90d0c950dd8d..654c7f4a247c 100644
--- a/app/Http/Controllers/OpenAPI/PaymentSchema.php
+++ b/app/Http/Controllers/OpenAPI/PaymentSchema.php
@@ -19,5 +19,23 @@
  *       @OA\Property(property="updated_at", type="number", format="integer", example="1434342123", description="Timestamp"),
  *       @OA\Property(property="archived_at", type="number", format="integer", example="1434342123", description="Timestamp"),
  *       @OA\Property(property="company_gateway_id", type="string", example="3", description="The company gateway id"),
+ *       @OA\Property(property="paymentables",ref="#/components/schemas/Paymentable"),
+ *       @OA\Property(
+ *       	property="invoices",
+ *        	type="array",
+ *        	description="",
+ *        	@OA\Items(
+ *           	ref="#/components/schemas/InvoicePaymentable",
+ *          ),
+ *       ),
+ *       @OA\Property(
+ *       	property="credits",
+ *        	type="array",
+ *        	description="",
+ *        	@OA\Items(
+ *           	ref="#/components/schemas/CreditPaymentable",
+ *          ),
+ *       ),
+ *       
  * )
  */
diff --git a/app/Http/Controllers/OpenAPI/PaymentableSchema.php b/app/Http/Controllers/OpenAPI/PaymentableSchema.php
new file mode 100644
index 000000000000..f145837684a7
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/PaymentableSchema.php
@@ -0,0 +1,14 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="Paymentable",
+ *   type="object",
+ *       @OA\Property(property="id", type="string", example="AS3df3A", description="The paymentable hashed id"),
+ *       @OA\Property(property="invoice_id", type="string", example="AS3df3A", description="The invoice hashed id"),
+ *       @OA\Property(property="credit_id", type="string", example="AS3df3A", description="The credit hashed id"),
+ *       @OA\Property(property="refunded", type="number", format="float", example="10.00", description="______"),
+ *       @OA\Property(property="amount", type="number", format="float", example="10.00", description="______"),
+ *       @OA\Property(property="updated_at", type="number", format="integer", example="1434342123", description="Timestamp"),
+ *       @OA\Property(property="created_at", type="number", format="integer", example="1434342123", description="Timestamp"),*       
+ * )
+ */
diff --git a/app/Http/Controllers/PaymentController.php b/app/Http/Controllers/PaymentController.php
index 820480e876b0..dab446a8341f 100644
--- a/app/Http/Controllers/PaymentController.php
+++ b/app/Http/Controllers/PaymentController.php
@@ -181,36 +181,7 @@ class PaymentController extends BaseController
      *      @OA\RequestBody(
      *         description="The payment request",
      *         required=true,
-     *         @OA\MediaType(
-     *             mediaType="application/json",
-     *             @OA\Schema(
-     *                 type="object",
-     *                 @OA\Property(
-     *                     property="amount",
-     *                     description="The payment amount",
-     *                     type="number",
-     *                     format="float",
-     *                 ),
-     *                 @OA\Property(
-     *                     property="date",
-     *                     example="2019/12/1",
-     *                     description="The payment date",
-     *                     type="string",
-     *                 ),
-     *                 @OA\Property(
-     *                     property="transation_reference",
-     *                     example="sdfasdfs98776d6kbkfd",
-     *                     description="The transaction reference for the payment",
-     *                     type="string",
-     *                 ),
-     *                 @OA\Property(
-     *                     property="invoices",
-     *                     example="j7s76d,s8765afk,D8fj3Sfdj",
-     *                     description="A comma separated list of invoice hashed ids that this payment relates to",
-     *                     type="string",
-     *                 )
-     *             )
-     *         )
+     *         @OA\JsonContent(ref="#/components/schemas/Payment"),
      *     ),
      *      @OA\Response(
      *          response=200,
diff --git a/app/Transformers/PaymentableTransformer.php b/app/Transformers/PaymentableTransformer.php
index a6bde007a02d..eec42bcd0d49 100644
--- a/app/Transformers/PaymentableTransformer.php
+++ b/app/Transformers/PaymentableTransformer.php
@@ -42,6 +42,7 @@ class PaymentableTransformer extends EntityTransformer
             'id' => $this->encodePrimaryKey($paymentable->id),
             $entity_key => $this->encodePrimaryKey($paymentable->paymentable_id),
             'amount' => (float)$paymentable->amount,
+            'refunded' => (float)$paymentable->refunded,
             'created_at' => (int) $paymentable->created_at,
             'updated_at' => (int) $paymentable->updated_at,
         ];