GITBOOK-31: change request with no subject merged in GitBook

UmbHost · Aug 5, 2023 · c4aa40e · c4aa40e
1 parent 101f0c5
commit c4aa40e
Show file tree

Hide file tree

Showing 66 changed files with 416 additions and 200 deletions.
diff --git a/.gitbook/assets/MetaDataPropertyEditor.png b/.gitbook/assets/MetaDataPropertyEditor.png
diff --git a/.gitbook/assets/TaxRatePropertyEditor.png b/.gitbook/assets/TaxRatePropertyEditor.png
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -13,8 +13,6 @@
 ## Configuration
 
 * [Configuration Options](configuration/configuration-options.md)
-* [Shipping Rates](configuration/shipping-rates.md)
-* [Tax Rates](configuration/tax-rates.md)
 
 ## Core Services
 
@@ -28,24 +26,26 @@
   * [UmbCheckoutConfiguration](core-services/object-reference/umbcheckoutconfiguration.md)
   * [MultiUrlPicker](core-services/object-reference/multiurlpicker.md)
 * [Cookies](core-services/cookies.md)
+* [Addons](core-services/addons/README.md)
+  * [Database Service](core-services/addons/database-service.md)
 
 ## Payment Providers
 
 * [Stripe](payment-providers/stripe/README.md)
-  * [Stripe Session Service](payment-providers/stripe/stripe-session-service.md)
-  * [Stripe Shipping Rate Database Service](payment-providers/stripe/stripe-database-service.md)
-  * [Stripe Shipping Rate ApiService](payment-providers/stripe/stripe-shipping-rate-apiservice.md)
-  * [Stripe Tax Rate ApiService](payment-providers/stripe/stripe-tax-rate-apiservice.md)
-  * [Stripe Tax Rate Database Service](payment-providers/stripe/stripe-tax-rate-database-service.md)
-  * [Stripe Basket Controller](payment-providers/stripe/stripe-basket-controller.md)
-  * [Stripe Webhook Api](payment-providers/stripe/stripe-webhook-api.md)
+  * [Installation](payment-providers/stripe/installation.md)
+  * [Configuration](payment-providers/stripe/configuration.md)
+  * [Shipping Rates](payment-providers/stripe/shipping-rates.md)
+  * [Services](payment-providers/stripe/services/README.md)
+    * [Stripe Shipping Rate ApiService](payment-providers/stripe/services/stripe-shipping-rate-apiservice.md)
+    * [Stripe Shipping Rate Database Service](payment-providers/stripe/services/stripe-shipping-rate-database-service.md)
+    * [Stripe Session Service](payment-providers/stripe/services/stripe-session-service.md)
+    * [Stripe Basket Controller](payment-providers/stripe/services/stripe-basket-controller.md)
+    * [Stripe Webhook Api](payment-providers/stripe/services/stripe-webhook-api.md)
   * [Notifications](payment-providers/stripe/notifications/README.md)
     * [OnCheckoutSessionCompletedNotification](payment-providers/stripe/notifications/oncheckoutsessioncompletednotification.md)
     * [OnCheckoutSessionExpiredNotification](payment-providers/stripe/notifications/oncheckoutsessionexpirednotification.md)
     * [OnPaymentFailedNotification](payment-providers/stripe/notifications/onpaymentfailednotification.md)
     * [OnShippingRateSavedNotification](payment-providers/stripe/notifications/onshippingratesavednotification.md)
-    * [OnStripeTaxRateDeletedNotification](payment-providers/stripe/notifications/onstripetaxratedeletednotification.md)
-    * [OnStripeTaxRateSavedNotification](payment-providers/stripe/notifications/onstripetaxratesavednotification.md)
     * [OnShippingRateDeletedNotification](payment-providers/stripe/notifications/onshippingratedeletednotification.md)
     * [OnPaymentSuccessNotification](payment-providers/stripe/notifications/onpaymentsuccessnotification.md)
   * [Object Reference](payment-providers/stripe/object-reference/README.md)
@@ -56,6 +56,18 @@
     * [TaxRateResponse](payment-providers/stripe/object-reference/taxrateresponse.md)
     * [ShippingRateResponse](payment-providers/stripe/object-reference/shippingrateresponse.md)
     * [ShippingRate](payment-providers/stripe/object-reference/shippingrate.md)
+  * [Property Editors](payment-providers/stripe/property-editors/README.md)
+    * [Meta Data Property Editor](payment-providers/stripe/property-editors/meta-data-property-editor.md)
+* [Addons](payment-providers/addons/README.md)
+  * [Tax Rates](payment-providers/addons/tax-rates.md)
+  * [Services](payment-providers/addons/services/README.md)
+    * [Stripe Tax Rate ApiService](payment-providers/addons/services/stripe-tax-rate-apiservice.md)
+    * [Stripe Tax Rate Database Service](payment-providers/addons/services/stripe-tax-rate-database-service.md)
+  * [Notifications](payment-providers/addons/notifications/README.md)
+    * [OnStripeTaxRateSavedNotification](payment-providers/addons/notifications/onstripetaxratesavednotification.md)
+    * [OnStripeTaxRateDeletedNotification](payment-providers/addons/notifications/onstripetaxratedeletednotification.md)
+  * [Property Editors](payment-providers/addons/property-editors/README.md)
+    * [Tax Rates Property Editor](payment-providers/addons/property-editors/tax-rates-property-editor.md)
 * [GoCardless](payment-providers/gocardless.md)
 * [PayPal](payment-providers/paypal.md)
 * [Klarna](payment-providers/klarna.md)
@@ -92,13 +104,10 @@
   * [OnProviderGetSessionStartedNotification](scheduled-tasks-and-notifications/payment-provider-notifications/onprovidergetsessionstartednotification.md)
   * [OnProviderSessionClearedNotification](scheduled-tasks-and-notifications/payment-provider-notifications/onprovidersessionclearednotification.md)
   * [OnProviderSessionCreatedNotification](scheduled-tasks-and-notifications/payment-provider-notifications/onprovidersessioncreatednotification.md)
+* [Configuration Notifications](scheduled-tasks-and-notifications/configuration-notifications/README.md)
+  * [OnConfigurationSavedNotification](scheduled-tasks-and-notifications/configuration-notifications/onconfigurationsavednotification.md)
 
 ## View Components
 
 * [Basket View Component](view-components/basket-view-component.md)
 * [Basket Link View Component](view-components/basket-link-view-component.md)
-
-## Property Editors
-
-* [Tax Rates Property Editor](property-editors/tax-rates-property-editor.md)
-* [Meta Data Property Editor](property-editors/meta-data-property-editor.md)
diff --git a/configuration/configuration-options.md b/configuration/configuration-options.md
@@ -10,11 +10,11 @@ The configuration options and their possible options are as below:
 | ------------------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | Success Page URL               | Picker  | Select either a content node or enter an external URL                                                                                                                   |
 | Cancel Page URL                | Picker  | Select either a content node or enter an external URL                                                                                                                   |
+| Enable Shipping                | Boolean | <p><strong>True:</strong> The shipping rates are passed to the payment provider<br><br><strong>False:</strong> No shipping rates are passed to the payment provider</p> |
 | \*Store Basket In a Cookie     | Boolean | <p><strong>True:</strong> A cookie is set which stores the users current Basket<br><br><strong>False:</strong> No cookie is set</p>                                     |
 | \*Basket Expiry (Cookie)       | Integer | The number of days in the future the cookie expires (30 by default)                                                                                                     |
 | \*Store Basket In The Database | Boolean | <p><strong>True:</strong> The users current Basket is stored in the database<br><br><strong>False:</strong> The Basket is not stored</p>                                |
 | \*Basket Expiry (Database)     | Integer | The maximum number of days the Basket is stored in the database                                                                                                         |
-| Enable Shipping                | Boolean | <p><strong>True:</strong> The shipping rates are passed to the payment provider<br><br><strong>False:</strong> No shipping rates are passed to the payment provider</p> |
 
 {% hint style="info" %}
 Features marked with \* require a paid license

diff --git a/core-services/addons/README.md b/core-services/addons/README.md
@@ -0,0 +1,2 @@
+# Addons
+
diff --git a/core-services/addons/database-service.md b/core-services/addons/database-service.md
@@ -0,0 +1,56 @@
+---
+description: A service which handles storing of the Basket in the database
+---
+
+# Database Service
+
+{% hint style="info" %}
+This feature requires a paid license
+{% endhint %}
+
+The database service is what handles the insertion, updating, and clearing of the UmbCheckout Basket within the database.
+
+You can access the database service by injecting `IDatabaseService` which can be found within the namespace `UmbCheckout.Core.Addons.Interfaces`
+
+#### UpdateBasket
+
+Updates the stored Basket
+
+Parameters:
+
+| Name      | Detail                                                                  |
+| --------- | ----------------------------------------------------------------------- |
+| sessionId | The session to retrieve the [Basket](../object-reference/basket.md) for |
+| basket    | The [Basket](../object-reference/basket.md) to be stored                |
+
+```csharp
+Task<Basket> UpdateBasket(string sessionId, Basket basket);
+```
+
+#### DeleteBasket
+
+Deleted the stored Basket
+
+Parameters:
+
+| Name      | Detail                                                                |
+| --------- | --------------------------------------------------------------------- |
+| sessionId | The session to delete the [Basket](../object-reference/basket.md) for |
+
+```csharp
+Task DeleteBasket(string sessionId);
+```
+
+#### DeleteBaskets
+
+Deleted all of the stored Baskets older than the specified days
+
+Parameters:
+
+| Name           | Detail                  |
+| -------------- | ----------------------- |
+| expiryDateTime | The days to delete from |
+
+```csharp
+Task DeleteBaskets(DateTime expiryDateTime);
+```
diff --git a/core-services/basket-service.md b/core-services/basket-service.md
@@ -1,3 +1,7 @@
+---
+description: A service which handles all things around the basket
+---
+
 # Basket Service
 
 The basket service is what and handles all the UmbCheckout Basket operations.
@@ -6,55 +10,85 @@ You can access the basket service by injecting `IBasketService` which can be fou
 
 #### Get
 
-Gets the Baset
+Gets the [Basket](object-reference/basket.md)
 
 ```csharp
 Task<Basket> Get();
 ```
 
 #### Add
 
-Adds an item to the Basket
+Adds an item to the [Basket](object-reference/basket.md)
+
+Parameters:
+
+| Name | Detail                                                         |
+| ---- | -------------------------------------------------------------- |
+| item | [Item](object-reference/lineitem.md) to be added to the Basket |
 
 ```csharp
 Task<Basket> Add(LineItem item);
 ```
 
 #### Add Multiple
 
-Adds multiple items to the Basket
+Adds multiple items to the [Basket](object-reference/basket.md)
+
+Parameters:
+
+| Name  | Detail                                                          |
+| ----- | --------------------------------------------------------------- |
+| items | [Items](object-reference/lineitem.md) to be added to the Basket |
 
 ```csharp
 Task<Basket> Add(IEnumerable<LineItem> items);
 ```
 
 #### Reduce
 
-Reduces the specified item by a count of 1 or removes from the Basket if only 1
+Reduces the specified item by a count of 1 or removes from the [Basket](object-reference/basket.md) if only 1
+
+Parameters:
+
+| Name | Detail                                                           |
+| ---- | ---------------------------------------------------------------- |
+| id   | [Item](object-reference/lineitem.md) to be reduced in the Basket |
 
 ```csharp
 Task<Basket> Reduce(Guid id);
 ```
 
 #### Remove
 
-Removes the specified item from the Basket
+Removes the specified item from the [Basket](object-reference/basket.md)
+
+Parameters:
+
+| Name | Detail                                                             |
+| ---- | ------------------------------------------------------------------ |
+| id   | [Item](object-reference/lineitem.md) to be removed from the Basket |
 
 ```csharp
 Task<Basket> Remove(Guid id);
 ```
 
 #### Remove Multiple
 
-Removes multiple items from the Basket
+Removes multiple items from the [Basket](object-reference/basket.md)
+
+Parameters:
+
+| Name | Detail                                                              |
+| ---- | ------------------------------------------------------------------- |
+| ids  | [Items](object-reference/lineitem.md) to be removed from the Basket |
 
 ```csharp
 Task<Basket> Remove(IEnumerable<Guid> ids);
 ```
 
 #### Clear
 
-Removes all items from the Basket and clears any set Basket cookies
+Removes all items from the Basket and clears any set [Basket](object-reference/basket.md) cookies
 
 ```csharp
 Task<Basket> Clear();
@@ -70,7 +104,7 @@ Task<long> TotalItems();
 
 #### SubTotal
 
-Returns the Basket subtotal (minus any shipping or tax)
+Returns the [Basket](object-reference/basket.md) subtotal (minus any shipping or tax)
 
 ```csharp
 Task<decimal> SubTotal();

diff --git a/core-services/database-service.md b/core-services/database-service.md
@@ -1,41 +1,23 @@
-# Database Service
+---
+description: A service which handles storing of the Basket in the database
+---
 
-{% hint style="info" %}
-This feature requires a paid license
-{% endhint %}
+# Database Service
 
-The database service is what and handles the insertion, retrieval, updating and clearing of the UmbCheckout Basket within the database.
+The database service is what handles the retrieval of the UmbCheckout Basket within the database.
 
 You can access the database service by injecting `IDatabaseService` which can be found within the namespace`UmbCheckout.Core.Interfaces`
 
 #### GetBasket
 
 The gets the stored Basket
 
-```csharp
-Task<Basket?> GetBasket(string sessionId);
-```
+Parameters:
 
-#### UpdateBasket
-
-Updates the stored Basket
+| Name      | Detail                                                               |
+| --------- | -------------------------------------------------------------------- |
+| sessionId | The session to retrieve the [Basket](object-reference/basket.md) for |
 
 ```csharp
-Task<Basket> UpdateBasket(string sessionId, Basket basket);
-```
-
-#### DeleteBasket
-
-Deleted the stored Basket
-
-```csharp
-Task DeleteBasket(string sessionId);
-```
-
-#### DeleteBaskets
-
-Deleted all of the stored Baskets older than the specified days
-
-```csharp
-Task DeleteBaskets(DateTime expiryDateTime);
+Task<Basket?> GetBasket(string sessionId);
 ```
diff --git a/core-services/object-reference/umbcheckoutconfiguration.md b/core-services/object-reference/umbcheckoutconfiguration.md
@@ -5,6 +5,7 @@ The UmbCheckoutConfiguration object contains the below properties
 | Property Name          | Type                                             | Use                                                    |
 | ---------------------- | ------------------------------------------------ | ------------------------------------------------------ |
 | Id                     | int                                              | The internal configuration Id                          |
+| Key                    | Guid                                             | The internal configuration Key                         |
 | SuccessPageUrl         | IEnumerable<[MultiUrlPicker](multiurlpicker.md)> | The success page                                       |
 | CancelPageUrl          | IEnumerable<[MultiUrlPicker](multiurlpicker.md)> | The cancel page                                        |
 | StoreBasketInCookie    | Boolean                                          | Whether the Basket is stored in a cookie               |

diff --git a/core-services/object-reference/umbcheckoutsession.md b/core-services/object-reference/umbcheckoutsession.md
@@ -2,6 +2,6 @@
 
 The UmbCheckoutSession object contains the below properties
 
-| Property Name | Type                | Use           |
-| ------------- | ------------------- | ------------- |
-| Basket        | [Basket](basket.md) | The Basket id |
+| Property Name | Type                | Use        |
+| ------------- | ------------------- | ---------- |
+| Basket        | [Basket](basket.md) | The Basket |
diff --git a/core-services/session-service.md b/core-services/session-service.md
@@ -1,3 +1,7 @@
+---
+description: A service to handle the Get, Update and Clearing of the Session
+---
+
 # Session Service
 
 The session service is what creates and handles the creation, retrieval, updating and clearing of the UmbCheckout Basket within the .NET session.
@@ -14,7 +18,13 @@ Task<UmbCheckoutSession> Get();
 
 #### Update
 
-Updates the current UmbCheckout session or creates a new session if not found
+Updates the current UmbCheckout session or create a new session if not found
+
+Parameters:
+
+| Name   | Detail                                   |
+| ------ | ---------------------------------------- |
+| basket | The [Basket](object-reference/basket.md) |
 
 ```csharp
 Task<UmbCheckoutSession> Update(Basket basket);

diff --git a/getting-started/configuration.md b/getting-started/configuration.md
@@ -8,19 +8,12 @@ There is no additional coding required to make use of UmbCheckout after being in
 
 After the package is installed head to Settings -> UmbCheckout -> Configuration to set the Checkout **Success** and **Cancel** pages / URLs.
 
-You will need to add your Stripe Secret API key into your `appsettings.json` below the `LicenseKey` as below:
-
 ```json
   "UmbCheckout": {
-    "LicenseKey": "YOUR LICENSE KEY HERE",
-    "Stripe": {
-      "ApiKey": "STRIPE SECRET API KEY"
-    }
+    "LicenseKey": "YOUR LICENSE KEY HERE"
   }
 ```
 
-You can find your Stripe Secret API key [within your account](https://dashboard.stripe.com/apikeys) by heading to `Developers -> API keys`
-
 ### Required Product Properties
 
 Your product needs to have the following required properties added
@@ -31,7 +24,6 @@ Your product needs to have the following required properties added
 
 Your product can have the following optional properties
 
-| Alias                  | Property Type                                                 |
-| ---------------------- | ------------------------------------------------------------- |
-| umbCheckoutDescription | Text Area                                                     |
-| umbCheckoutMetaData    | [Meta Data](../property-editors/meta-data-property-editor.md) |
+| Alias                  | Property Type |
+| ---------------------- | ------------- |
+| umbCheckoutDescription | Text Area     |