@spree/docs 0.1.89 → 0.1.90
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/developer/sdk/admin/authentication.md +3 -2
- package/dist/developer/sdk/admin/querying-and-errors.md +3 -2
- package/dist/developer/sdk/admin/quickstart.md +2 -2
- package/dist/developer/sdk/admin/resources.md +3 -2
- package/dist/developer/sdk/quickstart.md +3 -2
- package/dist/developer/tutorial/api.md +2 -1
- package/package.json +1 -1
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
3
|
-
|
|
2
|
+
title: "Admin SDK authentication with API keys and JWT cookies"
|
|
3
|
+
sidebarTitle: "Authentication"
|
|
4
|
+
description: "Authenticate @spree/admin-sdk with a secret API key for server-to-server, scope-based access or JWT cookie auth for role-based browser admin apps."
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
The Admin API supports two authentication methods. Both reach the same endpoints — they differ in **where the credential lives** and **how authorization is decided**:
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
3
|
-
|
|
2
|
+
title: "Filtering, pagination, and error handling in the Admin SDK"
|
|
3
|
+
sidebarTitle: "Querying & Errors"
|
|
4
|
+
description: "Filter, sort, paginate, and expand Admin API collections with flat Ransack parameters and handle structured SpreeError responses from @spree/admin-sdk."
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
## Filtering
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Admin SDK"
|
|
2
|
+
title: "Admin SDK quickstart for @spree/admin-sdk"
|
|
3
3
|
sidebarTitle: Quickstart
|
|
4
|
-
description: "
|
|
4
|
+
description: "Install and configure @spree/admin-sdk, the official TypeScript client for the Spree Admin API v3, to manage products, orders, customers, and stock."
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
[`@spree/admin-sdk`](https://www.npmjs.com/package/@spree/admin-sdk) is the official TypeScript SDK for the [Admin API v3](../../../api-reference/admin-api/introduction.md) — the back-office counterpart to [`@spree/sdk`](../quickstart.md). Use it to build integrations, automations, internal tools, and custom admin UIs: manage products, orders, customers, stock, promotions, webhooks, and more.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
3
|
-
|
|
2
|
+
title: "Admin SDK resources and CRUD client methods"
|
|
3
|
+
sidebarTitle: "Resources"
|
|
4
|
+
description: "Reference for every @spree/admin-sdk resource — products, orders, customers, inventory, pricing, promotions, store configuration, and platform clients."
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
Every Admin API resource is exposed as a property on the client (`client.orders`, `client.products`, …). Collection resources follow a consistent CRUD shape — `list`, `get`, `create`, `update`, `delete` — plus resource-specific actions. Nested resources take the **parent ID as the first argument**:
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
3
|
-
|
|
2
|
+
title: Spree TypeScript SDK quickstart for the Store API
|
|
3
|
+
sidebarTitle: Quickstart
|
|
4
|
+
description: Install @spree/sdk, configure the Store API client, and make your first calls to products, carts, checkout, and customer account endpoints from TypeScript.
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
`@spree/sdk` is the customer-facing SDK — products, carts, checkout, and account flows against the Store API. For back-office integrations (managing products, orders, customers, stock), use the [Admin SDK](admin/quickstart.md).
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
2
|
+
title: Expose a custom model through the Store and Admin APIs
|
|
3
|
+
sidebarTitle: API
|
|
3
4
|
description: Expose your custom Brand model through the Spree Store and Admin REST APIs with serializers, controllers, routes, and the spree:api_resource generator.
|
|
4
5
|
---
|
|
5
6
|
|