Skip to content

Commit

Permalink
GITBOOK-32: change request with no subject merged in GitBook
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronSadlerUK authored and gitbook-bot committed Aug 5, 2023
1 parent c4aa40e commit 32e059a
Show file tree
Hide file tree
Showing 24 changed files with 143 additions and 64 deletions.
44 changes: 28 additions & 16 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

* [🛒 UmbCheckout Documentation](README.md)

## Getting Started
## 📔 Getting Started

* [Overview](getting-started/overview.md)
* [License Comparison](getting-started/license-comparison.md)
* [Installation](getting-started/installation.md)
* [Configuration](getting-started/configuration.md)
* [Buy a License](https://my.umbhost.net/store/umbraco-packages)

## Configuration
## 🛠 Configuration

* [Configuration Options](configuration/configuration-options.md)

## Core Services
## 🛒 Core Services

* [Session Service](core-services/session-service.md)
* [Database Service](core-services/database-service.md)
Expand All @@ -29,7 +29,7 @@
* [Addons](core-services/addons/README.md)
* [Database Service](core-services/addons/database-service.md)

## Payment Providers
## 💰 Payment Providers

* [Stripe](payment-providers/stripe/README.md)
* [Installation](payment-providers/stripe/installation.md)
Expand Down Expand Up @@ -58,21 +58,27 @@
* [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)
* [uSync](payment-providers/stripe/usync/README.md)
* [Installation](payment-providers/stripe/usync/installation.md)
* [Synchronising Changes](synchronising/usync/synchronising-changes.md)
* [Addons](payment-providers/stripe/addons/README.md)
* [Tax Rates](payment-providers/stripe/addons/tax-rates.md)
* [Services](payment-providers/stripe/addons/services/README.md)
* [Stripe Tax Rate ApiService](payment-providers/stripe/addons/services/stripe-tax-rate-apiservice.md)
* [Stripe Tax Rate Database Service](payment-providers/stripe/addons/services/stripe-tax-rate-database-service.md)
* [Notifications](payment-providers/stripe/addons/notifications/README.md)
* [OnStripeTaxRateSavedNotification](payment-providers/stripe/addons/notifications/onstripetaxratesavednotification.md)
* [OnStripeTaxRateDeletedNotification](payment-providers/stripe/addons/notifications/onstripetaxratedeletednotification.md)
* [Property Editors](payment-providers/stripe/addons/property-editors/README.md)
* [Tax Rates Property Editor](payment-providers/stripe/addons/property-editors/tax-rates-property-editor.md)
* [uSync](payment-providers/stripe/addons/usync/README.md)
* [Installation](payment-providers/stripe/addons/usync/installation.md)
* [Synchronising Changes](synchronising/usync/synchronising-changes.md)
* [GoCardless](payment-providers/gocardless.md)
* [PayPal](payment-providers/paypal.md)
* [Klarna](payment-providers/klarna.md)

## Scheduled Tasks & Notifications
## Scheduled Tasks & Notifications

* [Remove Expired Baskets From Database](scheduled-tasks-and-notifications/remove-expired-baskets-from-database.md)
* [Basket Notifications](scheduled-tasks-and-notifications/basket-notifications/README.md)
Expand Down Expand Up @@ -107,7 +113,13 @@
* [Configuration Notifications](scheduled-tasks-and-notifications/configuration-notifications/README.md)
* [OnConfigurationSavedNotification](scheduled-tasks-and-notifications/configuration-notifications/onconfigurationsavednotification.md)

## View Components
## 👨💻 View Components

* [Basket View Component](view-components/basket-view-component.md)
* [Basket Link View Component](view-components/basket-link-view-component.md)

## 🔁 Synchronising

* [uSync](synchronising/usync/README.md)
* [Installation](synchronising/usync/installation.md)
* [Synchronising Changes](synchronising/usync/synchronising-changes.md)
2 changes: 1 addition & 1 deletion getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Installing UmbCheckout
UmbCheckout is installed using the NuGet package manager using either the below command:

```
dotnet add package UmbCheckout --version 1.0.0
dotnet add package UmbCheckout
```

You will also need to install a [payment provider](broken-reference).
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
description: Notification which is triggered a Stripe Tax Rate is deleted
---

# OnStripeTaxRateDeletedNotification

The following properties are available within the notification

| Property Name | Type |
| ------------- | -------------------------------------------- |
| TaxRate | [TaxRate](../../object-reference/taxrate.md) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
description: Notification which is triggered a Stripe Tax Rate is saved
---

# OnStripeTaxRateSavedNotification

The following properties are available within the notification

| Property Name | Type |
| ------------- | -------------------------------------------- |
| TaxRate | [TaxRate](../../object-reference/taxrate.md) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Tax Rates Property Editor

The Tax Rates property editor allows you to assign a [TaxRate](../../object-reference/taxrate.md) to a product which is used to calculate owed tax during the checkout

<figure><img src="../../../../.gitbook/assets/TaxRatePropertyEditor.png" alt=""><figcaption></figcaption></figure>
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ Gets a specified Tax Rate

Parameters:

| Name | Detail |
| ---- | ---------------------------------------------------------------------- |
| key | Key of the Stripe [Tax Rate](../../stripe/object-reference/taxrate.md) |
| Name | Detail |
| ---- | --------------------------------------------------------------- |
| key | Key of the Stripe [Tax Rate](../../object-reference/taxrate.md) |

```csharp
Task<TaxRate?> GetTaxRate(Guid key);
Expand All @@ -40,9 +40,9 @@ Gets a specified Tax Rate

Parameters:

| Name | Detail |
| ----- | --------------------------------------------------------------------------- |
| value | StripeId of the Stripe [Tax Rate](../../stripe/object-reference/taxrate.md) |
| Name | Detail |
| ----- | -------------------------------------------------------------------- |
| value | StripeId of the Stripe [Tax Rate](../../object-reference/taxrate.md) |

```csharp
Task<TaxRate?> GetTaxRate(string value);
Expand All @@ -54,9 +54,9 @@ Creates a Tax Rate

Parameters:

| Name | Detail |
| ------- | --------------------------------------------------------------- |
| taxRate | The Stripe [Tax Rate](../../stripe/object-reference/taxrate.md) |
| Name | Detail |
| ------- | -------------------------------------------------------- |
| taxRate | The Stripe [Tax Rate](../../object-reference/taxrate.md) |

```csharp
Task<TaxRate?> CreateTaxRate(TaxRate taxRate);
Expand All @@ -68,9 +68,9 @@ Updates a specified Tax Rate

Parameters:

| Name | Detail |
| ------- | --------------------------------------------------------------- |
| taxRate | The Stripe [Tax Rate](../../stripe/object-reference/taxrate.md) |
| Name | Detail |
| ------- | -------------------------------------------------------- |
| taxRate | The Stripe [Tax Rate](../../object-reference/taxrate.md) |

```csharp
Task<TaxRate?> UpdateTaxRate(TaxRate taxRate);
Expand All @@ -82,9 +82,9 @@ Deletes a specified Tax Rate

Parameters:

| Name | Detail |
| ---- | ---------------------------------------------------------------------- |
| key | Key of the Stripe [Tax Rate](../../stripe/object-reference/taxrate.md) |
| Name | Detail |
| ---- | --------------------------------------------------------------- |
| key | Key of the Stripe [Tax Rate](../../object-reference/taxrate.md) |

```csharp
Task<bool> DeleteTaxRate(Guid key);
Expand Down
File renamed without changes.
7 changes: 7 additions & 0 deletions payment-providers/stripe/addons/usync/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
description: Documentation for the uSync Stripe Addon package
---

# uSync

The uSync Stripe package allows for the import and export of the Stripe Tax Rates between environments
13 changes: 13 additions & 0 deletions payment-providers/stripe/addons/usync/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
description: Installing uSync Stripe
---

# Installation

The uSync Stripe package is installed using the NuGet package manager using the below command:

```
dotnet add package UmbCheckout.Stripe.Addons.uSync
```

Alternatively, you can install using the NuGet package manager GUI within Visual Studio.
8 changes: 4 additions & 4 deletions payment-providers/stripe/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can find your Stripe Secret API key [within your account](https://dashboard.

Your product can have the following optional properties

| Alias | Property Type |
| ------------------- | -------------------------------------------------------------------- |
| umbCheckoutMetaData | [Meta Data](property-editors/meta-data-property-editor.md) |
| umbCheckoutTaxRates | [Tax Rates](../addons/property-editors/tax-rates-property-editor.md) |
| Alias | Property Type |
| ------------------- | ----------------------------------------------------------------- |
| umbCheckoutMetaData | [Meta Data](property-editors/meta-data-property-editor.md) |
| umbCheckoutTaxRates | [Tax Rates](addons/property-editors/tax-rates-property-editor.md) |
2 changes: 1 addition & 1 deletion payment-providers/stripe/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Installing Stripe Payment Provider
The Stripe Payment Provider is installed using the NuGet package manager using the below command:

```
dotnet add package UmbCheckout.Stripe --version 1.0.0
dotnet add package UmbCheckout.Stripe
```

Alternatively, you can install using the NuGet package manager GUI within Visual Studio.
7 changes: 7 additions & 0 deletions payment-providers/stripe/usync/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
description: Documentation for the uSync Stripe Addon package
---

# uSync

The uSync Stripe package allows for the import and export of the Stripe Shipping Rates between environments
13 changes: 13 additions & 0 deletions payment-providers/stripe/usync/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
description: Installing uSync Stripe
---

# Installation

The uSync Stripe package is installed using the NuGet package manager using the below command:

```
dotnet add package UmbCheckout.Stripe.uSync
```

Alternatively, you can install using the NuGet package manager GUI within Visual Studio.
7 changes: 7 additions & 0 deletions synchronising/usync/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
description: Documentation for the uSync Addon package
---

# uSync

The uSync package allows for the import and export of the UmbCheckout configuration between environments
13 changes: 13 additions & 0 deletions synchronising/usync/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
description: Installing uSync
---

# Installation

The uSync package is installed using the NuGet package manager using the below command:

```
dotnet add package UmbCheckout.uSync
```

Alternatively, you can install using the NuGet package manager GUI within Visual Studio.
7 changes: 7 additions & 0 deletions synchronising/usync/synchronising-changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Synchronising Changes

Once installed uSync will create config files on disk in the uSync folder alongside other uSync content.

These files should be committed to your repository and transferred between environments.

Depending on your uSync configuration the importing and exporting may occur either manually or automatically.

0 comments on commit 32e059a

Please sign in to comment.