Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Regenerated the API reference and SDK request types for the security fixes

Damian Legawieca7853827efe2
diff --git a/docs/api-reference/admin.yaml b/docs/api-reference/admin.yaml
index e14853819e..1b4c9a7bd8 100644
--- a/docs/api-reference/admin.yaml
+++ b/docs/api-reference/admin.yaml
@@ -2019,7 +2019,7 @@ paths:
`docs/plans/5.5-admin-auth-cookie-refresh.md`).
- **Required scope:** `read_settings` (for API-key authentication).
+ **Required scope:** `read_staff` (for API-key authentication).
x-codeSamples:
- lang: javascript
label: Spree Admin SDK
@@ -2164,7 +2164,7 @@ paths:
`https`.
- **Required scope:** `write_settings` (for API-key authentication).
+ **Required scope:** `write_staff` (for API-key authentication).
x-codeSamples:
- lang: javascript
label: Spree Admin SDK
@@ -2245,7 +2245,7 @@ paths:
description: |-
Returns a single allowed origin by prefixed ID.
- **Required scope:** `read_settings` (for API-key authentication).
+ **Required scope:** `read_staff` (for API-key authentication).
x-codeSamples:
- lang: javascript
label: Spree Admin SDK
@@ -2311,7 +2311,7 @@ paths:
description: |-
Updates an existing allowed origin.
- **Required scope:** `write_settings` (for API-key authentication).
+ **Required scope:** `write_staff` (for API-key authentication).
x-codeSamples:
- lang: javascript
label: Spree Admin SDK
@@ -2389,7 +2389,7 @@ paths:
admin API from a browser.
- **Required scope:** `write_settings` (for API-key authentication).
+ **Required scope:** `write_staff` (for API-key authentication).
x-codeSamples:
- lang: javascript
label: Spree Admin SDK
@@ -15580,7 +15580,7 @@ paths:
description: |-
Settles an approved claim with money back, a replacement shipment, or both.
- **Required scope:** `write_orders` (for API-key authentication).
+ **Required scope:** `write_orders`, plus `write_refunds` for a resolution that refunds (for API-key authentication).
x-codeSamples:
- lang: javascript
label: Spree Admin SDK
@@ -16663,7 +16663,7 @@ paths:
description: |-
Ships the replacements for a received exchange and settles any price difference.
- **Required scope:** `write_orders` (for API-key authentication).
+ **Required scope:** `write_orders`, plus `write_refunds` when the customer is owed a difference (for API-key authentication).
x-codeSamples:
- lang: javascript
label: Spree Admin SDK
@@ -19778,7 +19778,7 @@ paths:
Set `notify_customer: true` to send the order cancellation email.
- **Required scope:** `write_orders` (for API-key authentication).
+ **Required scope:** `write_orders`, plus `write_refunds` with `refund_payments` (for API-key authentication).
x-codeSamples:
- lang: javascript
label: Spree Admin SDK
@@ -20809,7 +20809,7 @@ paths:
description: |-
Pays the customer back for a received return, to store credit or through the original payment.
- **Required scope:** `write_orders` (for API-key authentication).
+ **Required scope:** `write_orders` and `write_refunds` (for API-key authentication).
x-codeSamples:
- lang: javascript
label: Spree Admin SDK
@@ -32157,7 +32157,7 @@ paths:
content:
application/json:
example:
- current_version: 6.0.0.rc4
+ current_version: 6.0.0.rc5
enabled: true
checked_at: '2026-10-03T04:00:00.000Z'
update_available: true
@@ -78693,14 +78693,6 @@ components:
type: string
phone:
type: string
- password:
- type: string
- description: 'Optional: a customer created without one claims the account
- through a password reset.'
- password_confirmation:
- type: string
- description: 'Optional: a customer created without one claims the account
- through a password reset.'
selected_locale:
type: string
avatar_signed_id:
diff --git a/docs/api-reference/store.yaml b/docs/api-reference/store.yaml
index c81462a73b..5fb2ff67b9 100644
--- a/docs/api-reference/store.yaml
+++ b/docs/api-reference/store.yaml
@@ -8653,7 +8653,7 @@ paths:
updated_at: '2026-01-15T12:00:00.000Z'
verified: true
verified_at: '2026-01-15T12:00:00Z'
- customer_id: cust_UkLWZg9DAJ
+ customer_id:
customer_groups: []
schema:
"$ref": "#/components/schemas/AuthResponse"
@@ -24702,6 +24702,8 @@ components:
password:
type: string
+ description: 'Changing it signs the customer out everywhere: every refresh
+ token is revoked, so sign in again once the access token expires.'
password_confirmation:
type: string
current_password:
diff --git a/packages/admin-sdk/src/types/params/CustomerUpdateParams.ts b/packages/admin-sdk/src/types/params/CustomerUpdateParams.ts
index 278177f36d..7ef6a3c8aa 100644
--- a/packages/admin-sdk/src/types/params/CustomerUpdateParams.ts
+++ b/packages/admin-sdk/src/types/params/CustomerUpdateParams.ts
@@ -5,10 +5,6 @@ export type CustomerUpdateParams = {
first_name?: string
last_name?: string
phone?: string
- /** Optional: a customer created without one claims the account through a password reset. */
- password?: string
- /** Optional: a customer created without one claims the account through a password reset. */
- password_confirmation?: string
selected_locale?: string
/** A `signed_id` from `files.upload()`. */
avatar_signed_id?: string
diff --git a/packages/sdk/src/types/params/UpdateCustomerParams.ts b/packages/sdk/src/types/params/UpdateCustomerParams.ts
index fd09ab4f09..c7f9430a14 100644
--- a/packages/sdk/src/types/params/UpdateCustomerParams.ts
+++ b/packages/sdk/src/types/params/UpdateCustomerParams.ts
@@ -2,6 +2,10 @@
export type UpdateCustomerParams = {
email?: string
+ /**
+ * Changing it signs the customer out everywhere: every refresh token is revoked, so sign in again
+ * once the access token expires.
+ */
password?: string
password_confirmation?: string
/** Required when changing the email or the password. */