From a54b6c30557bc795a37d28b26be52c2627fa25c4 Mon Sep 17 00:00:00 2001
From: David Bomba <turbo124@gmail.com>
Date: Mon, 7 Oct 2019 15:57:14 +1100
Subject: [PATCH] Finalized OpenAPI

---
 app/Http/Controllers/ClientController.php     |  2 +-
 .../Controllers/OpenAPI/BulkActionSchema.php  | 11 ++++++++
 .../OpenAPI/ClientGatewayToken.php            | 13 +++++++++
 .../OpenAPI/CompanyGatewaySchema.php          | 28 +++++++++++++++++++
 .../Controllers/OpenAPI/PaymentSchema.php     |  8 ++++++
 .../Controllers/OpenAPI/ProductSchema.php     |  8 ++++++
 app/Http/Controllers/OpenAPI/QuoteSchema.php  |  8 ++++++
 .../Controllers/OpenAPI/RecurringInvoice.php  |  8 ++++++
 .../Controllers/OpenAPI/RecurringQuote.php    |  8 ++++++
 app/Http/Controllers/PaymentController.php    |  4 +--
 app/Http/Controllers/ProductController.php    |  6 ++--
 app/Http/Controllers/QuoteController.php      |  6 ++--
 .../RecurringInvoiceController.php            |  6 ++--
 .../Controllers/RecurringQuoteController.php  |  6 ++--
 app/Http/Controllers/UserController.php       |  6 ++--
 15 files changed, 110 insertions(+), 18 deletions(-)
 create mode 100644 app/Http/Controllers/OpenAPI/BulkActionSchema.php
 create mode 100644 app/Http/Controllers/OpenAPI/ClientGatewayToken.php
 create mode 100644 app/Http/Controllers/OpenAPI/CompanyGatewaySchema.php
 create mode 100644 app/Http/Controllers/OpenAPI/PaymentSchema.php
 create mode 100644 app/Http/Controllers/OpenAPI/ProductSchema.php
 create mode 100644 app/Http/Controllers/OpenAPI/QuoteSchema.php
 create mode 100644 app/Http/Controllers/OpenAPI/RecurringInvoice.php
 create mode 100644 app/Http/Controllers/OpenAPI/RecurringQuote.php

diff --git a/app/Http/Controllers/ClientController.php b/app/Http/Controllers/ClientController.php
index ae575c0057be..1cd34c0b2615 100644
--- a/app/Http/Controllers/ClientController.php
+++ b/app/Http/Controllers/ClientController.php
@@ -479,7 +479,7 @@ class ClientController extends BaseController
      *          @OA\Header(header="X-API-TOKEN", ref="#/components/headers/X-API-TOKEN"),
      *          @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/ClientUser"),
+     *          @OA\JsonContent(ref="#/components/schemas/Client"),
      *       ),
      *       @OA\Response(
      *          response=422,
diff --git a/app/Http/Controllers/OpenAPI/BulkActionSchema.php b/app/Http/Controllers/OpenAPI/BulkActionSchema.php
new file mode 100644
index 000000000000..3fca84c36d0d
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/BulkActionSchema.php
@@ -0,0 +1,11 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="BulkAction",
+ *   type="array",
+ *       @OA\Items(
+ *         	type="integer",
+ *          example="[0,1,2,3,]"
+ *          ),
+ * )
+ */
\ No newline at end of file
diff --git a/app/Http/Controllers/OpenAPI/ClientGatewayToken.php b/app/Http/Controllers/OpenAPI/ClientGatewayToken.php
new file mode 100644
index 000000000000..56b90d11a46a
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/ClientGatewayToken.php
@@ -0,0 +1,13 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="ClientGatewayToken",
+ *   type="object",
+ *       @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
+ *       @OA\Property(property="company_id", type="string", example="2", description="______"),
+ *       @OA\Property(property="client_id", type="string", example="2", description="______"),
+ *       @OA\Property(property="token", type="string", example="2", description="______"),
+ *       @OA\Property(property="company_gateway_id", type="string", example="2", description="______"),
+ *       @OA\Property(property="is_default", type="boolean", example="true", description="______"),
+ * )
+ */
\ No newline at end of file
diff --git a/app/Http/Controllers/OpenAPI/CompanyGatewaySchema.php b/app/Http/Controllers/OpenAPI/CompanyGatewaySchema.php
new file mode 100644
index 000000000000..a088601b14bd
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/CompanyGatewaySchema.php
@@ -0,0 +1,28 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="CompanyGateway",
+ *   type="object",
+ *       @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
+ *       @OA\Property(property="company_id", type="string", example="2", description="______"),
+ *       @OA\Property(property="gateway_key", type="string", example="2", description="______"),
+ *       @OA\Property(property="accepted_credit_cards", type="integer", example="32", description="Bitmask representation of cards"),
+ *       @OA\Property(property="show_address", type="boolean", example=true, description="______"),
+ *       @OA\Property(property="show_shipping_address", type="boolean", example=true, description="______"),
+ *       @OA\Property(property="update_details", type="boolean", example=true, description="______"),
+ *       @OA\Property(property="adjust_fee_percent", type="boolean", example=true, description="______"),
+ *       @OA\Property(property="config", type="string", example="2", description="______"),
+ *       @OA\Property(property="priority_id", type="string", example="2", description="______"),
+ *       @OA\Property(property="user_id", type="string", example="2", description="______"),
+ *       @OA\Property(property="min_limit", type="string", example="2", description="______"),
+ *       @OA\Property(property="max_limit", type="string", example="2", description="______"),
+ *       @OA\Property(property="fee_amount", type="number", format="float", example="2.0", description="______"),
+ *       @OA\Property(property="fee_percent", type="number", format="float", example="2.0", description="______"),
+ *       @OA\Property(property="fee_tax_name1", type="string", example="2", description="______"),
+ *       @OA\Property(property="fee_tax_name2", type="string", example="2", description="______"),
+ *       @OA\Property(property="fee_tax_rate1", type="number", format="float", example="2.0", description="______"),
+ *       @OA\Property(property="fee_tax_rate2", type="number", format="float", example="2.0", description="______"),
+ *       @OA\Property(property="fee_cap", type="number", format="float", example="2.0", description="______"),
+ * )
+ */
+     
\ No newline at end of file
diff --git a/app/Http/Controllers/OpenAPI/PaymentSchema.php b/app/Http/Controllers/OpenAPI/PaymentSchema.php
new file mode 100644
index 000000000000..468238c40a4e
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/PaymentSchema.php
@@ -0,0 +1,8 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="Payment",
+ *   type="object",
+ *       @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
+ * )
+ */
\ No newline at end of file
diff --git a/app/Http/Controllers/OpenAPI/ProductSchema.php b/app/Http/Controllers/OpenAPI/ProductSchema.php
new file mode 100644
index 000000000000..d3bb8d0aba90
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/ProductSchema.php
@@ -0,0 +1,8 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="Product",
+ *   type="object",
+ *       @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
+ * )
+ */
\ No newline at end of file
diff --git a/app/Http/Controllers/OpenAPI/QuoteSchema.php b/app/Http/Controllers/OpenAPI/QuoteSchema.php
new file mode 100644
index 000000000000..75229e49b5a5
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/QuoteSchema.php
@@ -0,0 +1,8 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="Quote",
+ *   type="object",
+ *       @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
+ * )
+ */
\ No newline at end of file
diff --git a/app/Http/Controllers/OpenAPI/RecurringInvoice.php b/app/Http/Controllers/OpenAPI/RecurringInvoice.php
new file mode 100644
index 000000000000..fbb80363384a
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/RecurringInvoice.php
@@ -0,0 +1,8 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="RecurringInvoice",
+ *   type="object",
+ *       @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
+ * )
+ */
\ No newline at end of file
diff --git a/app/Http/Controllers/OpenAPI/RecurringQuote.php b/app/Http/Controllers/OpenAPI/RecurringQuote.php
new file mode 100644
index 000000000000..acff067242d5
--- /dev/null
+++ b/app/Http/Controllers/OpenAPI/RecurringQuote.php
@@ -0,0 +1,8 @@
+<?php
+/**
+ * @OA\Schema(
+ *   schema="RecurringQuote",
+ *   type="object",
+ *       @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
+ * )
+ */
\ No newline at end of file
diff --git a/app/Http/Controllers/PaymentController.php b/app/Http/Controllers/PaymentController.php
index 08445d7166be..aa6786e94040 100644
--- a/app/Http/Controllers/PaymentController.php
+++ b/app/Http/Controllers/PaymentController.php
@@ -488,11 +488,11 @@ class PaymentController extends BaseController
      *     ),
      *      @OA\Response(
      *          response=200,
-     *          description="The Payment User response",
+     *          description="The Payment response",
      *          @OA\Header(header="X-API-TOKEN", ref="#/components/headers/X-API-TOKEN"),
      *          @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/PaymentUser"),
+     *          @OA\JsonContent(ref="#/components/schemas/Payment"),
      *       ),
      *       @OA\Response(
      *          response=422,
diff --git a/app/Http/Controllers/ProductController.php b/app/Http/Controllers/ProductController.php
index bfa356ef9fb0..942f9c62b22a 100644
--- a/app/Http/Controllers/ProductController.php
+++ b/app/Http/Controllers/ProductController.php
@@ -427,7 +427,7 @@ class ProductController extends BaseController
      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
      *      @OA\Parameter(ref="#/components/parameters/index"),
      *      @OA\RequestBody(
-     *         description="User credentials",
+     *         description="Hashed IDs",
      *         required=true,
      *         @OA\MediaType(
      *             mediaType="application/json",
@@ -443,11 +443,11 @@ class ProductController extends BaseController
      *     ),
      *      @OA\Response(
      *          response=200,
-     *          description="The Product User response",
+     *          description="The Product response",
      *          @OA\Header(header="X-API-TOKEN", ref="#/components/headers/X-API-TOKEN"),
      *          @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/ProductUser"),
+     *          @OA\JsonContent(ref="#/components/schemas/Product"),
      *       ),
      *       @OA\Response(
      *          response=422,
diff --git a/app/Http/Controllers/QuoteController.php b/app/Http/Controllers/QuoteController.php
index b68cb518b5df..6237e0f2e756 100644
--- a/app/Http/Controllers/QuoteController.php
+++ b/app/Http/Controllers/QuoteController.php
@@ -464,7 +464,7 @@ class QuoteController extends BaseController
      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
      *      @OA\Parameter(ref="#/components/parameters/index"),
      *      @OA\RequestBody(
-     *         description="User credentials",
+     *         description="Hashed ids",
      *         required=true,
      *         @OA\MediaType(
      *             mediaType="application/json",
@@ -480,11 +480,11 @@ class QuoteController extends BaseController
      *     ),
      *      @OA\Response(
      *          response=200,
-     *          description="The Quote User response",
+     *          description="The Quote response",
      *          @OA\Header(header="X-API-TOKEN", ref="#/components/headers/X-API-TOKEN"),
      *          @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/QuoteUser"),
+     *          @OA\JsonContent(ref="#/components/schemas/Quote"),
      *       ),
      *       @OA\Response(
      *          response=422,
diff --git a/app/Http/Controllers/RecurringInvoiceController.php b/app/Http/Controllers/RecurringInvoiceController.php
index 45359891699b..0f860710f34f 100644
--- a/app/Http/Controllers/RecurringInvoiceController.php
+++ b/app/Http/Controllers/RecurringInvoiceController.php
@@ -474,7 +474,7 @@ class RecurringInvoiceController extends BaseController
      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
      *      @OA\Parameter(ref="#/components/parameters/index"),
      *      @OA\RequestBody(
-     *         description="User credentials",
+     *         description="Hashed IDs",
      *         required=true,
      *         @OA\MediaType(
      *             mediaType="application/json",
@@ -490,11 +490,11 @@ class RecurringInvoiceController extends BaseController
      *     ),
      *      @OA\Response(
      *          response=200,
-     *          description="The RecurringInvoice User response",
+     *          description="The RecurringInvoice response",
      *          @OA\Header(header="X-API-TOKEN", ref="#/components/headers/X-API-TOKEN"),
      *          @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/RecurringInvoiceUser"),
+     *          @OA\JsonContent(ref="#/components/schemas/RecurringInvoice"),
      *       ),
      *       @OA\Response(
      *          response=422,
diff --git a/app/Http/Controllers/RecurringQuoteController.php b/app/Http/Controllers/RecurringQuoteController.php
index 17eb7e50fc2d..48587aa44f0f 100644
--- a/app/Http/Controllers/RecurringQuoteController.php
+++ b/app/Http/Controllers/RecurringQuoteController.php
@@ -472,7 +472,7 @@ class RecurringQuoteController extends BaseController
      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
      *      @OA\Parameter(ref="#/components/parameters/index"),
      *      @OA\RequestBody(
-     *         description="User credentials",
+     *         description="Hashed ids",
      *         required=true,
      *         @OA\MediaType(
      *             mediaType="application/json",
@@ -488,11 +488,11 @@ class RecurringQuoteController extends BaseController
      *     ),
      *      @OA\Response(
      *          response=200,
-     *          description="The RecurringQuote User response",
+     *          description="The RecurringQuote response",
      *          @OA\Header(header="X-API-TOKEN", ref="#/components/headers/X-API-TOKEN"),
      *          @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/RecurringQuoteUser"),
+     *          @OA\JsonContent(ref="#/components/schemas/RecurringQuote"),
      *       ),
      *       @OA\Response(
      *          response=422,
diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php
index 79d98757ff80..636c721457bd 100644
--- a/app/Http/Controllers/UserController.php
+++ b/app/Http/Controllers/UserController.php
@@ -471,7 +471,7 @@ class UserController extends BaseController
      *      @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
      *      @OA\Parameter(ref="#/components/parameters/index"),
      *      @OA\RequestBody(
-     *         description="User credentials",
+     *         description="Hashed ids",
      *         required=true,
      *         @OA\MediaType(
      *             mediaType="application/json",
@@ -487,11 +487,11 @@ class UserController extends BaseController
      *     ),
      *      @OA\Response(
      *          response=200,
-     *          description="The User User response",
+     *          description="The User response",
      *          @OA\Header(header="X-API-TOKEN", ref="#/components/headers/X-API-TOKEN"),
      *          @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/UserUser"),
+     *          @OA\JsonContent(ref="#/components/schemas/User"),
      *       ),
      *       @OA\Response(
      *          response=422,