From 584bdfa5a74c552b6d12b961a04776455dcec857 Mon Sep 17 00:00:00 2001
From: Andrew McIntosh <amcintosh@freshbooks.com>
Date: Thu, 28 Mar 2024 14:21:28 -0400
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20docstrings?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 src/Exception/FreshBooksClientConfigException.php   | 5 +++++
 src/Exception/FreshBooksException.php               | 5 +++++
 src/Exception/FreshBooksNotImplementedException.php | 5 +++++
 src/FreshBooksClient.php                            | 5 +++++
 src/FreshBooksClientConfig.php                      | 2 ++
 src/Model/Service.php                               | 4 ++--
 6 files changed, 24 insertions(+), 2 deletions(-)

diff --git a/src/Exception/FreshBooksClientConfigException.php b/src/Exception/FreshBooksClientConfigException.php
index 103c0fe..822326b 100644
--- a/src/Exception/FreshBooksClientConfigException.php
+++ b/src/Exception/FreshBooksClientConfigException.php
@@ -4,6 +4,11 @@
 
 namespace amcintosh\FreshBooks\Exception;
 
+/**
+ * Exception thrown when the SDK has not been configured properly.
+ *
+ * @package amcintosh\FreshBooks\Exception
+ */
 final class FreshBooksClientConfigException extends \Exception
 {
     public function __construct(string $message)
diff --git a/src/Exception/FreshBooksException.php b/src/Exception/FreshBooksException.php
index 81c636d..87b0c0f 100644
--- a/src/Exception/FreshBooksException.php
+++ b/src/Exception/FreshBooksException.php
@@ -4,6 +4,11 @@
 
 namespace amcintosh\FreshBooks\Exception;
 
+/**
+ * Exception thrown when the FreshBooks API returns an error.
+ *
+ * @package amcintosh\FreshBooks\Exception
+ */
 final class FreshBooksException extends \Exception
 {
     public ?string $rawResponse;
diff --git a/src/Exception/FreshBooksNotImplementedException.php b/src/Exception/FreshBooksNotImplementedException.php
index 2aa5f5d..d16785f 100644
--- a/src/Exception/FreshBooksNotImplementedException.php
+++ b/src/Exception/FreshBooksNotImplementedException.php
@@ -4,6 +4,11 @@
 
 namespace amcintosh\FreshBooks\Exception;
 
+/**
+ * Exception thrown when attempting to make an API call that is not supported.
+ *
+ * @package amcintosh\FreshBooks\Exception
+ */
 final class FreshBooksNotImplementedException extends \Exception
 {
     public function __construct(
diff --git a/src/FreshBooksClient.php b/src/FreshBooksClient.php
index 4f8724f..bf1ebbe 100644
--- a/src/FreshBooksClient.php
+++ b/src/FreshBooksClient.php
@@ -44,6 +44,11 @@
 use amcintosh\FreshBooks\Resource\PaymentResource;
 use amcintosh\FreshBooks\Resource\ProjectResource;
 
+/**
+ * SDK Client.
+ *
+ * @package amcintosh\FreshBooks
+ */
 class FreshBooksClient
 {
     protected ClientInterface $httpClient;
diff --git a/src/FreshBooksClientConfig.php b/src/FreshBooksClientConfig.php
index d0edff9..bff0779 100644
--- a/src/FreshBooksClientConfig.php
+++ b/src/FreshBooksClientConfig.php
@@ -8,6 +8,8 @@
 
 /**
  * Configuration object for FreshBooks API Client
+ *
+ * @package amcintosh\FreshBooks
  */
 class FreshBooksClientConfig
 {
diff --git a/src/Model/Service.php b/src/Model/Service.php
index 2ca49aa..3e357f0 100644
--- a/src/Model/Service.php
+++ b/src/Model/Service.php
@@ -27,8 +27,8 @@
  *
  * Services automatically get converted to tasks for inclusion on invoices.
  *
- * @link https://www.freshbooks.com/api/project
- * @see <a href="https://www.freshbooks.com/api/services">FreshBooks API - Services</a>
+ * @package amcintosh\FreshBooks\Model
+ * @link https://www.freshbooks.com/api/services
  */
 class Service extends DataTransferObject
 {