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.

Sprint 3 SDK — paymentMethods.types() accessor

Damian Legawiec86778f92a169
diff --git a/packages/admin-sdk/src/admin-client.ts b/packages/admin-sdk/src/admin-client.ts
index 2f8144818a..2c81e2c9a4 100644
--- a/packages/admin-sdk/src/admin-client.ts
+++ b/packages/admin-sdk/src/admin-client.ts
@@ -120,6 +120,7 @@ import type {
OrderUpdateParams,
PaymentCreateParams,
PaymentMethodCreateParams,
+ PaymentMethodType,
PaymentMethodUpdateParams,
ProductUpdateParams,
StockItemUpdateParams,
@@ -907,6 +908,9 @@ export class AdminClient {
delete: (id: string, options?: RequestOptions): Promise<void> =>
this.request<void>('DELETE', `/payment_methods/${id}`, options),
+
+ types: (options?: RequestOptions): Promise<{ data: PaymentMethodType[] }> =>
+ this.request<{ data: PaymentMethodType[] }>('GET', '/payment_methods/types', options),
}
// ============================================
diff --git a/packages/admin-sdk/src/params.ts b/packages/admin-sdk/src/params.ts
index 3e89965f30..ffbb57e9a3 100644
--- a/packages/admin-sdk/src/params.ts
+++ b/packages/admin-sdk/src/params.ts
@@ -492,6 +492,16 @@ export interface PaymentMethodUpdateParams {
metadata?: Record<string, unknown>
}
+/**
+ * One entry returned by `GET /payment_methods/types` — the registered list
+ * of available STI subclasses for the create form.
+ */
+export interface PaymentMethodType {
+ type: string
+ label: string
+ description: string | null
+}
+
/**
* Built-in `Spree::Export` subclasses. The server validates `type` against
* the configured allowlist (`Spree::Export.available_types`); a plugin can