CS fixes and comments

rentpost · Sep 15, 2020 · e1d75fd · e1d75fd
1 parent 0c24cef
commit e1d75fd
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 56 deletions.
diff --git a/src/Client/SubResource/AddressSubResource.php b/src/Client/SubResource/AddressSubResource.php
@@ -4,9 +4,11 @@
 
 namespace Rentpost\ForteApi\Client\SubResource;
 
-use Rentpost\ForteApi\Model;
-use Rentpost\ForteApi\Attribute;
-
+/**
+ * Addresses
+ *
+ * Not implemented - pull requests welcome
+ */
 class AddressSubResource extends AbstractSubResource
 {
 }
diff --git a/src/Client/SubResource/CustomerSubResource.php b/src/Client/SubResource/CustomerSubResource.php
@@ -4,9 +4,11 @@
 
 namespace Rentpost\ForteApi\Client\SubResource;
 
-use Rentpost\ForteApi\Model;
-use Rentpost\ForteApi\Attribute;
-
+/**
+ * Customers
+ *
+ * Not implemented - pull requests welcome
+ */
 class CustomerSubResource extends AbstractSubResource
 {
 }
diff --git a/src/Client/SubResource/DisputeSubResource.php b/src/Client/SubResource/DisputeSubResource.php
@@ -7,6 +7,7 @@
 use Rentpost\ForteApi\Attribute;
 use Rentpost\ForteApi\Filter\DisputeFilter;
 use Rentpost\ForteApi\Model;
+use Rentpost\ForteApi\UriBuilder\PaginationData;
 use Rentpost\ForteApi\UriBuilder\UriBuilder;
 
 /**
@@ -21,7 +22,6 @@ class DisputeSubResource extends AbstractSubResource
      * Finds a dispute
      *
      * @param Attribute\Id\OrganizationId $organizationId       Use reseller org id if reseller
-     * @param Attribute\Id\DisputeId $disputeId
      */
     public function findOne(
         Attribute\Id\OrganizationId $organizationId,
@@ -41,8 +41,6 @@ public function findOne(
      * Finds a collection of disputes
      *
      * @param Attribute\Id\OrganizationId $organizationId       Use reseller org id if reseller
-     * @param DisputeFilter|null $filter
-     * @param PaginationData|null $pagination
      */
     public function find(
         Attribute\Id\OrganizationId $organizationId,
@@ -52,9 +50,9 @@ public function find(
     {
         $uri = UriBuilder::build(
             'organizations/%s/disputes/',
-            [ $organizationId->getValue() ],
+            [$organizationId->getValue()],
             $filter,
-            $pagination
+            $pagination,
         );
 
         return $this->getHttpClient()->makeModelRequest('get', $uri, Model\DisputeCollection::class);

diff --git a/src/Client/SubResource/DocumentSubResource.php b/src/Client/SubResource/DocumentSubResource.php
@@ -22,9 +22,6 @@ class DocumentSubResource extends AbstractSubResource
      * @note we use the reseller org id here since only resellers need to add documents
      *
      * @see https://www.forte.net/devdocs/api_resources/forte_api_v3.htm#documents
-     *
-     * @param Model\Document $document
-     * @param Model\Attachment $attachment
      */
     public function create(Model\Document $document, Model\Attachment $attachment): Model\Document
     {
@@ -39,10 +36,6 @@ public function create(Model\Document $document, Model\Attachment $attachment):
      * Finds a document
      *
      * @note we use the reseller org id here since only resellers use documents
-     *
-     * @param Attribute\Id\DocumentId $documentId
-     *
-     * @throws \Rentpost\ForteApi\Exception\LibraryFaultException
      */
     public function findOne(Attribute\Id\DocumentId $documentId): Model\Document
     {

diff --git a/src/Client/SubResource/FundingSubResource.php b/src/Client/SubResource/FundingSubResource.php
@@ -7,6 +7,7 @@
 use Rentpost\ForteApi\Attribute;
 use Rentpost\ForteApi\Filter\FundingFilter;
 use Rentpost\ForteApi\Model;
+use Rentpost\ForteApi\UriBuilder\PaginationData;
 use Rentpost\ForteApi\UriBuilder\UriBuilder;
 
 
@@ -22,7 +23,6 @@ class FundingSubResource extends AbstractSubResource
      * Finds a funding
      *
      * @param Attribute\Id\OrganizationId $organizationId       Use reseller org id if reseller
-     * @param Attribute\Id\FundingId $fundingId
      */
     public function findOne(
         Attribute\Id\OrganizationId $organizationId,
@@ -43,7 +43,6 @@ public function findOne(
      *
      * @param Attribute\Id\OrganizationId $organizationId       Use reseller org id if reseller
      * @param FundingFilter $filter                             Filter required for this method
-     * @param PaginationData|null $pagination
      */
     public function find(
         Attribute\Id\OrganizationId $organizationId,
@@ -53,9 +52,9 @@ public function find(
     {
         $uri = UriBuilder::build(
             'organizations/%s/fundings',
-            [ $organizationId->getValue() ],
+            [$organizationId->getValue()],
             $filter,
-            $pagination
+            $pagination,
         );
 
         return $this->getHttpClient()->makeModelRequest('get', $uri, Model\FundingCollection::class);

diff --git a/src/Client/SubResource/LocationSubResource.php b/src/Client/SubResource/LocationSubResource.php
@@ -7,8 +7,9 @@
 use Rentpost\ForteApi\Attribute;
 use Rentpost\ForteApi\Filter\FundingFilter;
 use Rentpost\ForteApi\Model;
-use Rentpost\ForteApi\UriBuilder\UriBuilder;
 use Rentpost\ForteApi\Model\Location;
+use Rentpost\ForteApi\UriBuilder\PaginationData;
+use Rentpost\ForteApi\UriBuilder\UriBuilder;
 
 /**
  * LocationSubResource
@@ -22,7 +23,6 @@ class LocationSubResource extends AbstractSubResource
      * Finds a funding
      *
      * @param Attribute\Id\OrganizationId $organizationId       Use reseller org id if reseller
-     * @param Attribute\Id\LocationId $locationId
      */
     public function findOne(
         Attribute\Id\OrganizationId $organizationId,

diff --git a/src/Client/SubResource/PayMethodSubResource.php b/src/Client/SubResource/PayMethodSubResource.php
@@ -4,9 +4,11 @@
 
 namespace Rentpost\ForteApi\Client\SubResource;
 
-use Rentpost\ForteApi\Model;
-use Rentpost\ForteApi\Attribute;
-
+/**
+ * PayMethods
+ *
+ * Not implemented - pull requests welcome
+ */
 class PayMethodSubResource extends AbstractSubResource
 {
 }
diff --git a/src/Client/SubResource/ScheduleItemSubResource.php b/src/Client/SubResource/ScheduleItemSubResource.php
@@ -4,9 +4,11 @@
 
 namespace Rentpost\ForteApi\Client\SubResource;
 
-use Rentpost\ForteApi\Model;
-use Rentpost\ForteApi\Attribute;
-
+/**
+ * ScheduleItems
+ *
+ * Not implemented - pull requests welcome
+ */
 class ScheduleItemSubResource extends AbstractSubResource
 {
 }
diff --git a/src/Client/SubResource/ScheduleSubResource.php b/src/Client/SubResource/ScheduleSubResource.php
@@ -4,9 +4,11 @@
 
 namespace Rentpost\ForteApi\Client\SubResource;
 
-use Rentpost\ForteApi\Model;
-use Rentpost\ForteApi\Attribute;
-
+/**
+ * Schedlues
+ *
+ * Not implemented - Pull requests welcome
+ */
 class ScheduleSubResource extends AbstractSubResource
 {
 }
diff --git a/src/Client/SubResource/SettlementSubResource.php b/src/Client/SubResource/SettlementSubResource.php
@@ -22,7 +22,6 @@ class SettlementSubResource extends AbstractSubResource
      * Find for the organization which is authenticated
      *
      * @param SettlementFilter $filter          Unlike most other find() methods, this one requires filter
-     * @param PaginationData|null $pagination
      */
     public function findForEntireOrganization(
         SettlementFilter $filter,

diff --git a/src/Client/SubResource/TransactionSubResource.php b/src/Client/SubResource/TransactionSubResource.php
@@ -27,8 +27,6 @@ class TransactionSubResource extends AbstractSubResource
      * Creates a new transaction
      *
      * @param Attribute\Id\OrganizationId $organizationId       Use reseller org id if reseller
-     * @param Attribute\Id\LocationId $locationId
-     * @param Model\Transaction $transaction
      */
     public function create(
         Attribute\Id\OrganizationId $organizationId,
@@ -50,8 +48,6 @@ public function create(
      * Finds a single transaction
      *
      * @param Attribute\Id\OrganizationId $organizationId       Use reseller org id if reseller
-     * @param Attribute\Id\LocationId $locationId
-     * @param Attribute\Id\TransactionId $transactionId
      */
     public function findOne(
         Attribute\Id\OrganizationId $organizationId,
@@ -74,8 +70,6 @@ public function findOne(
      * seconds to become available. This will wait and retry a few times until it becomes available
      *
      * @param Attribute\Id\OrganizationId $organizationId       Use reseller org id if reseller
-     * @param Attribute\Id\LocationId $locationId
-     * @param Attribute\Id\TransactionId $transactionId
      */
     public function findOneWait(
         Attribute\Id\OrganizationId $organizationId,
@@ -129,9 +123,6 @@ public function findOneWait(
      * Finds all transactions
      *
      * @param Attribute\Id\OrganizationId $organizationId       Use reseller org id if reseller
-     * @param Attribute\Id\LocationId $locationId
-     * @param TransactionFilter $filter
-     * @param PaginationData|null $pagination
      */
     public function find(
         Attribute\Id\OrganizationId $organizationId,
@@ -147,7 +138,7 @@ public function find(
                 $locationId->getValue(),
             ],
             $filter,
-            $pagination
+            $pagination,
         );
 
         return $this->getHttpClient()->makeModelRequest('get', $uri, Model\TransactionCollection::class);
@@ -160,9 +151,6 @@ public function find(
      * relating to the authenticated Organization.
      *
      * @param TransactionFilter $filter         Unlike most other find() methods, this one requires filter
-     * @param PaginationData|null $pagination
-     *
-     * @return Model\TransactionCollection
      */
     public function findForEntireOrganization(
         TransactionFilter $filter,
@@ -177,11 +165,8 @@ public function findForEntireOrganization(
 
     /**
      * @param Attribute\Id\OrganizationId $organizationId   Use reseller org id if reseller
-     * @param Attribute\Id\LocationId $locationId
      * @param Model\Transaction $transactionBeenVoided      Note, only the transactionId and
      *                                                      authorizationCode need to be set for voiding
-     *
-     * @return Model\Transaction
      */
     public function void(
         Attribute\Id\OrganizationId $organizationId,
@@ -226,10 +211,6 @@ public function void(
      * then make another call to void.
      *
      * @param Attribute\Id\OrganizationId $organizationId           Use reseller org id if reseller
-     * @param Attribute\Id\LocationId $locationId
-     * @param Attribute\Id\TransactionId $transactionIdBeenVoided
-     *
-     * @return Model\Transaction
      */
     public function voidFromTransactionId(
         Attribute\Id\OrganizationId $organizationId,
@@ -240,13 +221,13 @@ public function voidFromTransactionId(
         $transaction = $this->findOne(
             $organizationId,
             $locationId,
-            $transactionIdBeenVoided
+            $transactionIdBeenVoided,
         );
 
         return $this->void(
             $organizationId,
             $locationId,
-            $transaction
+            $transaction,
         );
     }
 }