Merge pull request #29 from jolicode/prepare-4-3-0

CHANGELOG update for upcoming v4.3.0

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changes between versions
 
+## 4.3.0 (2021-01-18)
+
+ * add the `units` and `total_cost` properties to the `Expense` definition
+ * upgrade to `janephp/open-api` 6.3
+
 ## 4.2.0 (2020-10-20)
 
  * add support for the `is_active` query param on the `/reports/project_budget` endpoint - see jolicode/harvest-openapi-generator#14

doc/index.md

@@ -46,62 +46,62 @@ $clients = $harvestClient->listClients([
 
 ## Available operations
 
-Instead of `listClients()`, you can use all of these methods:
+Instead of the `listClients()` method above, you can use all of these methods:
 
  * Clients:
    * `listClients()`
    * `createClient()`
+   * `deleteClient()`
    * `retrieveClient()`
    * `updateClient()`
-   * `deleteClient()`
  * Company:
    * `retrieveCompany()`
    * `updateCompany()`
  * Contacts:
    * `listContacts()`
    * `createContact()`
+   * `deleteContact()`
    * `retrieveContact()`
    * `updateContact()`
-   * `deleteContact()`
  * Estimate Item Categories:
    * `listEstimateItemCategories()`
    * `createEstimateItemCategory()`
+   * `deleteEstimateItemCategory()`
    * `retrieveEstimateItemCategory()`
    * `updateEstimateItemCategory()`
-   * `deleteEstimateItemCategory()`
  * Estimates:
    * `listEstimates()`
    * `createEstimate()`
+   * `deleteEstimate()`
    * `retrieveEstimate()`
    * `updateEstimate()`
-   * `deleteEstimate()`
    * `listMessagesForEstimate()`
    * `createEstimateMessage()`
    * `deleteEstimateMessage()`
  * Expense Categories:
    * `listExpenseCategories()`
    * `createExpenseCategory()`
+   * `deleteExpenseCategory()`
    * `retrieveExpenseCategory()`
    * `updateExpenseCategory()`
-   * `deleteExpenseCategory()`
  * Expenses:
    * `listExpenses()`
    * `createExpense()`
+   * `deleteExpense()`
    * `retrieveExpense()`
    * `updateExpense()`
-   * `deleteExpense()`
  * Invoice Item Categories:
    * `listInvoiceItemCategories()`
    * `createInvoiceItemCategory()`
+   * `deleteInvoiceItemCategory()`
    * `retrieveInvoiceItemCategory()`
    * `updateInvoiceItemCategory()`
-   * `deleteInvoiceItemCategory()`
  * Invoices:
    * `listInvoices()`
    * `createInvoice()`
+   * `deleteInvoice()`
    * `retrieveInvoice()`
    * `updateInvoice()`
-   * `deleteInvoice()`
    * `listMessagesForInvoice()`
    * `createInvoiceMessage()`
    * `deleteInvoiceMessage()`
@@ -111,19 +111,19 @@ Instead of `listClients()`, you can use all of these methods:
  * Projects:
    * `listProjects()`
    * `createProject()`
+   * `deleteProject()`
    * `retrieveProject()`
    * `updateProject()`
-   * `deleteProject()`
    * `listTaskAssignmentsForSpecificProject()`
    * `createTaskAssignment()`
+   * `deleteTaskAssignment()`
    * `retrieveTaskAssignment()`
    * `updateTaskAssignment()`
-   * `deleteTaskAssignment()`
    * `listUserAssignmentsForSpecificProject()`
    * `createUserAssignment()`
+   * `deleteUserAssignment()`
    * `retrieveUserAssignment()`
    * `updateUserAssignment()`
-   * `deleteUserAssignment()`
  * Reports:
    * `expenseCategoriesReport()`
    * `clientsExpensesReport()`
@@ -138,23 +138,23 @@ Instead of `listClients()`, you can use all of these methods:
  * Roles:
    * `listRoles()`
    * `createRole()`
+   * `deleteRole()`
    * `retrieveRole()`
    * `updateRole()`
-   * `deleteRole()`
  * Task Assignments:
    * `listTaskAssignments()`
  * Tasks:
    * `listTasks()`
    * `createTask()`
+   * `deleteTask()`
    * `retrieveTask()`
    * `updateTask()`
-   * `deleteTask()`
  * Time Entries:
    * `listTimeEntries()`
    * `createTimeEntry()`
+   * `deleteTimeEntry()`
    * `retrieveTimeEntry()`
    * `updateTimeEntry()`
-   * `deleteTimeEntry()`
    * `deleteTimeEntryExternalReference()`
    * `restartStoppedTimeEntry()`
    * `stopRunningTimeEntry()`
@@ -165,9 +165,9 @@ Instead of `listClients()`, you can use all of these methods:
    * `createUser()`
    * `retrieveTheCurrentlyAuthenticatedUser()`
    * `listActiveProjectAssignmentsForTheCurrentlyAuthenticatedUser()`
+   * `deleteUser()`
    * `retrieveUser()`
    * `updateUser()`
-   * `deleteUser()`
    * `listBillableRatesForSpecificUser()`
    * `createBillableRate()`
    * `retrieveBillableRate()`

doc/updating-sdk.md

@@ -1,6 +1,12 @@
 # Updating the SDK
 
-# Fetch the latest OpenAPI specification version
+## Fetch the latest OpenAPI specification version
+
+This library is generated using an OpenApi definition which is itself
+generated. Therefore, you should not manually change the
+`Resources/harvest-openapi.yaml` file, but rather change the way it is
+generated in the [jolicode/harvest-openapi-generator](https://github.com/jolicode/harvest-openapi-generator)
+repository.
 
 Run the following command to retrieve the latest API spec: