Skip to content

Commit

Permalink
Remove entry for deleted routes and clarified auto generated docs abo…
Browse files Browse the repository at this point in the history
…ut recommendations (#302)

Co-authored-by: Henning Tirre <[email protected]>
  • Loading branch information
Henning3110 and Henning Tirre authored Oct 25, 2024
1 parent 0c2b2d9 commit f9775e3
Showing 1 changed file with 4 additions and 37 deletions.
41 changes: 4 additions & 37 deletions changelog/2024-10-24-api-changes-v2.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ tags:
- apiv2
- Contract
- Customer

---

import OperationHint from "@site/src/components/OperationHint";
Expand All @@ -16,80 +15,49 @@ On October 24, 2024, the mittwald API introduced several new endpoints, includin

{/* truncate */}



## Summary


- A new endpoint has been added to update the invoice settings of a customer with a PUT operation at the path `/internal-v2/customers/{customerId}/invoice-settings`.
- A new endpoint has been added to create a recommendation suggestion for a customer with a POST operation at the path `/v2/customers/{customerId}/recommendation-suggestions`.
- A new endpoint has been added to retrieve the wallet of a customer with a GET operation at the path `/v2/customers/{customerId}/wallet`.
- A new endpoint has been added to create a wallet for a customer with a POST operation at the path `/v2/customers/{customerId}/wallet`.

_Disclaimer: This summary is AI-generated. If you find any discrepancies, please refer to the detailed changes below._


## Detailed changes



### Changes in "Update InvoiceSettings of a Customer"


- endpoint added


For details, refer to the <OperationLink operation="invoice-replace-invoice-settings" apiVersion="v2" /> endpoint.



### Changes in "Lets us know your idea for our recommendation programm"


- endpoint added


For details, refer to the <OperationLink operation="customer-create-recommendation-suggestion" apiVersion="v2" /> endpoint.



### Changes in "Gets the Wallet of the Customer"


- endpoint added


For details, refer to the <OperationLink operation="customer-get-wallet" apiVersion="v2" /> endpoint.



### Changes in "Create the Wallet for the Customer"


- endpoint added


For details, refer to the <OperationLink operation="customer-create-wallet" apiVersion="v2" /> endpoint.




## Client package releases


### mittwald PHP SDK Release v2.1.76

The mittwald PHP SDK has been updated to version 2.1.76, introducing new features and API changes aimed at enhancing customer engagement and service management.
The mittwald PHP SDK has been updated to version 2.1.76, introducing new features and API changes aimed at enhancing customer engagement and service management.

#### Features Added

- **Recommendation Suggestion**: A new capability to suggest recommendations to customers has been introduced via the `createRecommendationSuggestion` endpoint. This allows customers to submit ideas for products or services they would like to see.

- **Wallet Management**: New functionality for creating and managing customer wallets has been implemented. The `createWallet` endpoint allows customers to manage their points and rewards, while the `getWallet` endpoint provides access to wallet details, including points and associated recommendations.
- **Recommendation Suggestion**: A new capability to suggest recommendations to customers has been introduced via the `createRecommendationSuggestion` endpoint. This allows customers to submit ideas for our new recommendation programm announced soon.
- **Wallet Management**: New functionality for creating and managing customer wallets has been implemented. The `createWallet` endpoint allows customers to manage their reward points, while the `getWallet` endpoint provides access to wallet details, including points.

#### API Changes

- **New Endpoints**:

- `POST /v2/customers/{customerId}/recommendation-suggestions`
- `POST /v2/customers/{customerId}/wallet`
- `GET /v2/customers/{customerId}/wallet`
Expand All @@ -99,4 +67,3 @@ The mittwald PHP SDK has been updated to version 2.1.76, introducing new feature
- **New Response Classes**: Several new response classes have been introduced to handle various outcomes for the new endpoints.

For more details, visit the [release page](https://github.com/mittwald/api-client-php/releases/tag/v2.1.76).

0 comments on commit f9775e3

Please sign in to comment.