From dda968af3a4c1d414d09c2a54d9a0b5318252670 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 28 Mar 2024 18:22:16 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20CI:=20automated=20Generate=20Doc?= =?UTF-8?q?umentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...ption-FreshBooksClientConfigException.html | 9 +- ...shBooks-Exception-FreshBooksException.html | 21 +- ...ion-FreshBooksNotImplementedException.html | 9 +- ...amcintosh-FreshBooks-FreshBooksClient.html | 54 +-- ...osh-FreshBooks-FreshBooksClientConfig.html | 41 +-- .../amcintosh-FreshBooks-Model-Service.html | 13 +- ...ption-freshbooksclientconfigexception.html | 2 +- .../src-exception-freshbooksexception.html | 2 +- ...ion-freshbooksnotimplementedexception.html | 2 +- docs/html/files/src-freshbooksclient.html | 2 +- docs/html/js/searchIndex.js | 8 +- .../amcintosh-freshbooks-exception.html | 2 +- .../html/namespaces/amcintosh-freshbooks.html | 2 +- .../amcintosh-FreshBooks-Exception.html | 321 ++++++++++++++++++ .../packages/amcintosh-FreshBooks-Model.html | 3 +- docs/html/packages/amcintosh-FreshBooks.html | 11 +- docs/html/packages/amcintosh.html | 3 +- docs/html/reports/errors.html | 26 +- 18 files changed, 421 insertions(+), 110 deletions(-) create mode 100644 docs/html/packages/amcintosh-FreshBooks-Exception.html diff --git a/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksClientConfigException.html b/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksClientConfigException.html index bf0db8e..dc6125e 100644 --- a/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksClientConfigException.html +++ b/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksClientConfigException.html @@ -163,6 +163,8 @@

in package @@ -179,11 +181,12 @@

- +

Exception thrown when the SDK has not been configured properly.

+ @@ -245,7 +248,7 @@

diff --git a/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksException.html b/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksException.html index 9034e53..61edc98 100644 --- a/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksException.html +++ b/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksException.html @@ -163,6 +163,8 @@

in package @@ -179,11 +181,12 @@

- +

Exception thrown when the FreshBooks API returns an error.

+ @@ -290,7 +293,7 @@

@@ -323,7 +326,7 @@

@@ -356,7 +359,7 @@

@@ -394,7 +397,7 @@

@@ -470,7 +473,7 @@

@@ -505,7 +508,7 @@

@@ -540,7 +543,7 @@

diff --git a/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksNotImplementedException.html b/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksNotImplementedException.html index ad175d3..0126cb6 100644 --- a/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksNotImplementedException.html +++ b/docs/html/classes/amcintosh-FreshBooks-Exception-FreshBooksNotImplementedException.html @@ -163,6 +163,8 @@

in package @@ -179,11 +181,12 @@

- +

Exception thrown when attempting to make an API call that is not supported.

+ @@ -245,7 +248,7 @@

diff --git a/docs/html/classes/amcintosh-FreshBooks-FreshBooksClient.html b/docs/html/classes/amcintosh-FreshBooks-FreshBooksClient.html index 517552a..22e6417 100644 --- a/docs/html/classes/amcintosh-FreshBooks-FreshBooksClient.html +++ b/docs/html/classes/amcintosh-FreshBooks-FreshBooksClient.html @@ -159,6 +159,7 @@

in package @@ -173,11 +174,12 @@

- +

SDK Client.

+ @@ -404,7 +406,7 @@

@@ -437,7 +439,7 @@

@@ -470,7 +472,7 @@

@@ -503,7 +505,7 @@

@@ -541,7 +543,7 @@

@@ -589,7 +591,7 @@

@@ -626,7 +628,7 @@

@@ -662,7 +664,7 @@

@@ -712,7 +714,7 @@

@@ -748,7 +750,7 @@

@@ -784,7 +786,7 @@

@@ -857,7 +859,7 @@

@@ -918,7 +920,7 @@

@@ -954,7 +956,7 @@

@@ -990,7 +992,7 @@

@@ -1026,7 +1028,7 @@

@@ -1062,7 +1064,7 @@

@@ -1098,7 +1100,7 @@

@@ -1134,7 +1136,7 @@

@@ -1207,7 +1209,7 @@

@@ -1243,7 +1245,7 @@

@@ -1279,7 +1281,7 @@

@@ -1314,7 +1316,7 @@

@@ -1349,7 +1351,7 @@

diff --git a/docs/html/classes/amcintosh-FreshBooks-FreshBooksClientConfig.html b/docs/html/classes/amcintosh-FreshBooks-FreshBooksClientConfig.html index 3a9302f..f6537ed 100644 --- a/docs/html/classes/amcintosh-FreshBooks-FreshBooksClientConfig.html +++ b/docs/html/classes/amcintosh-FreshBooks-FreshBooksClientConfig.html @@ -159,6 +159,7 @@

in package @@ -173,7 +174,7 @@

@@ -358,7 +359,7 @@

@@ -386,7 +387,7 @@

@@ -414,7 +415,7 @@

@@ -458,7 +459,7 @@

@@ -491,7 +492,7 @@

@@ -524,7 +525,7 @@

@@ -557,7 +558,7 @@

@@ -590,7 +591,7 @@

@@ -623,7 +624,7 @@

@@ -656,7 +657,7 @@

@@ -689,7 +690,7 @@

@@ -722,7 +723,7 @@

@@ -755,7 +756,7 @@

@@ -788,7 +789,7 @@

@@ -821,7 +822,7 @@

@@ -854,7 +855,7 @@

@@ -892,7 +893,7 @@

@@ -983,7 +984,7 @@

@@ -1019,7 +1020,7 @@

diff --git a/docs/html/classes/amcintosh-FreshBooks-Model-Service.html b/docs/html/classes/amcintosh-FreshBooks-Model-Service.html index 3a90536..bd23bb9 100644 --- a/docs/html/classes/amcintosh-FreshBooks-Model-Service.html +++ b/docs/html/classes/amcintosh-FreshBooks-Model-Service.html @@ -163,6 +163,8 @@

in package @@ -200,17 +202,8 @@

link
- https://www.freshbooks.com/api/project + https://www.freshbooks.com/api/services -
-
- see -
-
- -

FreshBooks API - Services

-
-
diff --git a/docs/html/files/src-exception-freshbooksclientconfigexception.html b/docs/html/files/src-exception-freshbooksclientconfigexception.html index edd451e..b360da4 100644 --- a/docs/html/files/src-exception-freshbooksclientconfigexception.html +++ b/docs/html/files/src-exception-freshbooksclientconfigexception.html @@ -172,7 +172,7 @@

-
FreshBooksClientConfigException
+
FreshBooksClientConfigException
Exception thrown when the SDK has not been configured properly.
diff --git a/docs/html/files/src-exception-freshbooksexception.html b/docs/html/files/src-exception-freshbooksexception.html index 76c4ee9..5c9f72b 100644 --- a/docs/html/files/src-exception-freshbooksexception.html +++ b/docs/html/files/src-exception-freshbooksexception.html @@ -172,7 +172,7 @@

-
FreshBooksException
+
FreshBooksException
Exception thrown when the FreshBooks API returns an error.
diff --git a/docs/html/files/src-exception-freshbooksnotimplementedexception.html b/docs/html/files/src-exception-freshbooksnotimplementedexception.html index dde3299..4e7df63 100644 --- a/docs/html/files/src-exception-freshbooksnotimplementedexception.html +++ b/docs/html/files/src-exception-freshbooksnotimplementedexception.html @@ -172,7 +172,7 @@

-
FreshBooksNotImplementedException
+
FreshBooksNotImplementedException
Exception thrown when attempting to make an API call that is not supported.
diff --git a/docs/html/files/src-freshbooksclient.html b/docs/html/files/src-freshbooksclient.html index d9857e3..6bbb08a 100644 --- a/docs/html/files/src-freshbooksclient.html +++ b/docs/html/files/src-freshbooksclient.html @@ -172,7 +172,7 @@

-
FreshBooksClient
+
FreshBooksClient
SDK Client.
diff --git a/docs/html/js/searchIndex.js b/docs/html/js/searchIndex.js index 379697b..dfabffa 100644 --- a/docs/html/js/searchIndex.js +++ b/docs/html/js/searchIndex.js @@ -178,7 +178,7 @@ Search.appendIndex( }, { "fqsen": "\\amcintosh\\FreshBooks\\Exception\\FreshBooksClientConfigException", "name": "FreshBooksClientConfigException", - "summary": "", + "summary": "Exception\u0020thrown\u0020when\u0020the\u0020SDK\u0020has\u0020not\u0020been\u0020configured\u0020properly.", "url": "classes/amcintosh-FreshBooks-Exception-FreshBooksClientConfigException.html" }, { "fqsen": "\\amcintosh\\FreshBooks\\Exception\\FreshBooksClientConfigException\u003A\u003A__construct\u0028\u0029", @@ -188,7 +188,7 @@ Search.appendIndex( }, { "fqsen": "\\amcintosh\\FreshBooks\\Exception\\FreshBooksException", "name": "FreshBooksException", - "summary": "", + "summary": "Exception\u0020thrown\u0020when\u0020the\u0020FreshBooks\u0020API\u0020returns\u0020an\u0020error.", "url": "classes/amcintosh-FreshBooks-Exception-FreshBooksException.html" }, { "fqsen": "\\amcintosh\\FreshBooks\\Exception\\FreshBooksException\u003A\u003A__construct\u0028\u0029", @@ -228,7 +228,7 @@ Search.appendIndex( }, { "fqsen": "\\amcintosh\\FreshBooks\\Exception\\FreshBooksNotImplementedException", "name": "FreshBooksNotImplementedException", - "summary": "", + "summary": "Exception\u0020thrown\u0020when\u0020attempting\u0020to\u0020make\u0020an\u0020API\u0020call\u0020that\u0020is\u0020not\u0020supported.", "url": "classes/amcintosh-FreshBooks-Exception-FreshBooksNotImplementedException.html" }, { "fqsen": "\\amcintosh\\FreshBooks\\Exception\\FreshBooksNotImplementedException\u003A\u003A__construct\u0028\u0029", @@ -238,7 +238,7 @@ Search.appendIndex( }, { "fqsen": "\\amcintosh\\FreshBooks\\FreshBooksClient", "name": "FreshBooksClient", - "summary": "", + "summary": "SDK\u0020Client.", "url": "classes/amcintosh-FreshBooks-FreshBooksClient.html" }, { "fqsen": "\\amcintosh\\FreshBooks\\FreshBooksClient\u003A\u003A__construct\u0028\u0029", diff --git a/docs/html/namespaces/amcintosh-freshbooks-exception.html b/docs/html/namespaces/amcintosh-freshbooks-exception.html index 550229a..0ff3683 100644 --- a/docs/html/namespaces/amcintosh-freshbooks-exception.html +++ b/docs/html/namespaces/amcintosh-freshbooks-exception.html @@ -169,7 +169,7 @@

-
FreshBooksClientConfigException
FreshBooksException
FreshBooksNotImplementedException
+
FreshBooksClientConfigException
Exception thrown when the SDK has not been configured properly.
FreshBooksException
Exception thrown when the FreshBooks API returns an error.
FreshBooksNotImplementedException
Exception thrown when attempting to make an API call that is not supported.
diff --git a/docs/html/namespaces/amcintosh-freshbooks.html b/docs/html/namespaces/amcintosh-freshbooks.html index 3d70fc1..4c28b44 100644 --- a/docs/html/namespaces/amcintosh-freshbooks.html +++ b/docs/html/namespaces/amcintosh-freshbooks.html @@ -179,7 +179,7 @@

-
FreshBooksClient
FreshBooksClientConfig
Configuration object for FreshBooks API Client
+
FreshBooksClient
SDK Client.
FreshBooksClientConfig
Configuration object for FreshBooks API Client
diff --git a/docs/html/packages/amcintosh-FreshBooks-Exception.html b/docs/html/packages/amcintosh-FreshBooks-Exception.html new file mode 100644 index 0000000..9c16272 --- /dev/null +++ b/docs/html/packages/amcintosh-FreshBooks-Exception.html @@ -0,0 +1,321 @@ + + + + + freshbooks-php-sdk + + + + + + + + + + + + + + + + + + + + + +
+

freshbooks-php-sdk

+ + + + + +
+ +
+
+ + + + +
+
+ + +
+

Exception

+ + +

+ Table of Contents + + +

+ + + + +

+ Classes + + +

+
+
FreshBooksClientConfigException
Exception thrown when the SDK has not been configured properly.
FreshBooksException
Exception thrown when the FreshBooks API returns an error.
FreshBooksNotImplementedException
Exception thrown when attempting to make an API call that is not supported.
+ + + + + + + + + + + +
+
+
+
+

+        
+ +
+
+ + + +
+
+
+ +
+ On this page + +
    +
  • Table Of Contents
  • +
  • + +
  • + + +
+
+ +
+
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    + + +
    + + + + + + + + diff --git a/docs/html/packages/amcintosh-FreshBooks-Model.html b/docs/html/packages/amcintosh-FreshBooks-Model.html index 4a2b5ec..cc03b17 100644 --- a/docs/html/packages/amcintosh-FreshBooks-Model.html +++ b/docs/html/packages/amcintosh-FreshBooks-Model.html @@ -180,7 +180,8 @@

    been created.
    InvoicePresentation
    Invoice Presentations are used to style an invoice including font, colors, and logos.
    InvoiceStatus
    Status values for an invoice.
    Item
    Items are stored from invoice lines to make invoicing easier in the future.
    ItemList
    Results of items list call containing list of items and pagination data.
    LineItem
    Invoice lines are used to determine the amount of an invoice, in addition to being able to tie the invoice to rebilled expenses. The invoice line type determines whether a line is an amount or whether it refers to an unbilled expense.
    ListMeta
    List Meta object for pagination details in project-like responses.
    Money
    Monetary amount represented by a decimal value and a currency code.
    Pages
    List call pagination details.
    Payment
    Payments are a record of the payments made on invoices.
    PaymentList
    Results of Payments list call containing list of payments and pagination data.
    Project
    Projects in FreshBooks are used to track business projects and related information -such as hourly rate, service(s) being offered, projected end date...etc
    ProjectGroup
    ProjectGroups contain of the members and pending invitations to become a member of a project.
    ProjectGroupInvitation
    Invitation to join a project.
    ProjectGroupMember
    Member of a project.
    ProjectLikeList
    Parent class for list results on project-like endpoints to share pagination details.
    ProjectList
    Results of Projects list call containing list of projects and pagination data.
    Task
    Tasks in Freshbooks represent services that your business offers to clients.
    TaskList
    Results of tasks list call containing list of tasks and pagination data.
    Tax
    System-wide taxes for invoices.
    TaxList
    Results of taxes list call containing list of taxes and pagination data.
    VisState
    Visibility values for a resource. Mostly used in accounting-type resources, not project-type.
    +such as hourly rate, service(s) being offered, projected end date...etc
    ProjectGroup
    ProjectGroups contain of the members and pending invitations to become a member of a project.
    ProjectGroupInvitation
    Invitation to join a project.
    ProjectGroupMember
    Member of a project.
    ProjectLikeList
    Parent class for list results on project-like endpoints to share pagination details.
    ProjectList
    Results of Projects list call containing list of projects and pagination data.
    Service
    Services represent things that a business offers to clients. Services are added to projects +to to allow tracking of time entries by type of work.
    Task
    Tasks in Freshbooks represent services that your business offers to clients.
    TaskList
    Results of tasks list call containing list of tasks and pagination data.
    Tax
    System-wide taxes for invoices.
    TaxList
    Results of taxes list call containing list of taxes and pagination data.
    VisState
    Visibility values for a resource. Mostly used in accounting-type resources, not project-type.
    diff --git a/docs/html/packages/amcintosh-FreshBooks.html b/docs/html/packages/amcintosh-FreshBooks.html index fa22879..234c035 100644 --- a/docs/html/packages/amcintosh-FreshBooks.html +++ b/docs/html/packages/amcintosh-FreshBooks.html @@ -166,12 +166,20 @@

    Builder
    +
    Exception
    Model
    Resource
    +

    + Classes + + +

    +
    +
    FreshBooksClient
    SDK Client.
    FreshBooksClientConfig
    Configuration object for FreshBooks API Client
    @@ -286,7 +294,8 @@

  • Table Of Contents
    • -
    +
  • Classes
  • + diff --git a/docs/html/packages/amcintosh.html b/docs/html/packages/amcintosh.html index 7f41499..71ff811 100644 --- a/docs/html/packages/amcintosh.html +++ b/docs/html/packages/amcintosh.html @@ -182,8 +182,7 @@

    -
    FreshBooksClientConfigException
    FreshBooksException
    FreshBooksNotImplementedException
    FreshBooksClient
    FreshBooksClientConfig
    Configuration object for FreshBooks API Client
    AccountingDateTimeImmutableCaster
    DateCaster
    DecimalCaster
    ISODateTimeImmutableCaster
    MoneyCaster
    TimestampDateTimeImmutableCaster
    Service
    Services represent things that a business offers to clients. Services are added to projects -to to allow tracking of time entries by type of work.
    AccountingResource
    AuthResource
    BaseResource
    PaymentResource
    ProjectResource
    +
    AccountingDateTimeImmutableCaster
    DateCaster
    DecimalCaster
    ISODateTimeImmutableCaster
    MoneyCaster
    TimestampDateTimeImmutableCaster
    AccountingResource
    AuthResource
    BaseResource
    PaymentResource
    ProjectResource
    diff --git a/docs/html/reports/errors.html b/docs/html/reports/errors.html index 57ba6e3..ded4ce3 100644 --- a/docs/html/reports/errors.html +++ b/docs/html/reports/errors.html @@ -153,33 +153,9 @@

    Fil

    Errors

    -

    Table of Contents

    - - - - - -
    src/Model/Service.php1
    +
    No errors have been found in this project.
    -
    -

    Service.php

    - - - - - - - - - - - - - - - -
    TypeLineDescription
    ERROR33Tag "see" with body "@see <a href="https://www.freshbooks.com/api/services">FreshBooks API - Services</a>" has error "\amcintosh\FreshBooks\Model\<a" is not a valid Fqsen.