@vansite/ts-sharetribe-flex-sdk 1.0.34 → 3.0.0

package/dist/types/endpoints/marketplace/Reviews.d.ts

@@ -1,50 +1,48 @@
 /**
- * @fileoverview Provides the Reviews class for managing reviews in the Sharetribe Marketplace API.
- * This class includes methods for querying and retrieving details of reviews.
+ * @fileoverview Client for querying reviews in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#reviews
+ * Use this to fetch your own reviews or reviews for listings you own.
+ * Only returns reviews the current user is authorized to see.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#reviews
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { ReviewsQueryParameter, ReviewsResponse, ReviewsShowParameter } from "../../types/marketplace/reviews";
+import { ReviewsQueryParameter, ReviewsResponse, ReviewsShowParameter } from "../../types";
 /**
- * Class representing the Reviews API.
- *
- * The Reviews API provides methods for querying and retrieving details of reviews within the marketplace.
+ * Reviews API client (own reviews only)
  */
 declare class Reviews {
-    private readonly endpoint;
+    readonly authRequired = true;
     private readonly axios;
+    private readonly endpoint;
     private readonly headers;
-    /**
-     * Creates an instance of the Reviews class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
     constructor(api: MarketplaceApi);
     /**
-     * Retrieves details of a specific review.
+     * Fetch a single review by ID
      *
      * @template P
-     * @param {P & ReviewsShowParameter} params - Parameters identifying the review.
-     * @returns {Promise<AxiosResponse<ReviewsResponse<'show', P>>>} - A promise resolving to the review details.
+     * @param {P & ReviewsShowParameter} params
+     * @returns {Promise<AxiosResponse<ReviewsResponse<"show", P>>>}
      *
      * @example
-     * const response = await sdk.reviews.show({ id: 'review-id' });
-     * const review = response.data;
+     * const { data } = await sdk.reviews.show({ id: "rev-abc123" });
      */
     show<P extends ReviewsShowParameter>(params: P): Promise<AxiosResponse<ReviewsResponse<"show", P>>>;
     /**
-     * Queries reviews based on specified filters.
+     * Query your own reviews or reviews for your listings
      *
      * @template P
-     * @param {P & ReviewsQueryParameter} params - Query parameters to filter reviews.
-     * @returns {Promise<AxiosResponse<ReviewsResponse<'query', P>>>} - A promise resolving to the query results.
+     * @param {P & ReviewsQueryParameter} params
+     * @returns {Promise<AxiosResponse<ReviewsResponse<"query", P>>>}
+     *
+     * @example
+     * // All reviews you've received
+     * const { data } = await sdk.reviews.query({ subjectId: "current" });
      *
      * @example
-     * const response = await sdk.reviews.query({ listingId: 'listing-id', perPage: 10 });
-     * const reviews = response.data;
+     * // Reviews for one of your listings
+     * await sdk.reviews.query({ listingId: "listing-abc123" });
      */
     query<P extends ReviewsQueryParameter>(params: P): Promise<AxiosResponse<ReviewsResponse<"query", P>>>;
 }

package/dist/types/endpoints/marketplace/Reviews.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Reviews.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Reviews.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,qBAAqB,EACrB,eAAe,EACf,oBAAoB,EACrB,MAAM,iCAAiC,CAAC;AAEzC;;;;GAIG;AACH,cAAM,OAAO;IACX,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IAEjD;;;;OAIG;gBACS,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;OAUG;IACG,IAAI,CAAC,CAAC,SAAS,oBAAoB,EACvC,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAOrD;;;;;;;;;;OAUG;IACG,KAAK,CAAC,CAAC,SAAS,qBAAqB,EACzC,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;CASvD;AAED,eAAe,OAAO,CAAC"}
+{"version":3,"file":"Reviews.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Reviews.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EAAC,qBAAqB,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAE1F;;GAEG;AACH,cAAM,OAAO;IACX,SAAgB,YAAY,QAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;OASG;IACG,IAAI,CAAC,CAAC,SAAS,oBAAoB,EACvC,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAOrD;;;;;;;;;;;;;;OAcG;IACG,KAAK,CAAC,CAAC,SAAS,qBAAqB,EACzC,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;CAMvD;AAED,eAAe,OAAO,CAAC"}

package/dist/types/endpoints/marketplace/SitemapData.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @fileoverview Client for querying sitemap data in the Sharetribe Marketplace API.
+ *
+ * Use this to generate XML sitemaps for SEO:
+ * - queryListings: Up to 10,000 most recent public listing IDs
+ * - queryAssets: CMS page asset paths from Console
+ *
+ * Note: Results are cached for 1 day by the API.
+ *
+ * @see https://www.sharetribe.com/docs/concepts/sitemap-in-sharetribe/
+ */
+import type { AxiosResponse } from "axios";
+import MarketplaceApi from "./index";
+import { SitemapAssetsResponse, SitemapListingsResponse } from "../../types/marketplace/sitemapData";
+/**
+ * Sitemap Data API client
+ *
+ * Provides access to sitemap generation endpoints.
+ * These endpoints return minimal data needed for sitemap XML generation.
+ */
+declare class SitemapData {
+    private readonly axios;
+    private readonly endpoint;
+    private readonly headers;
+    constructor(api: MarketplaceApi);
+    /**
+     * Query listing IDs for sitemap generation
+     *
+     * Returns up to 10,000 most recent public listings.
+     * For marketplaces with more listings, use Integration API
+     * with createdAt filtering for older listings.
+     *
+     * @returns {Promise<AxiosResponse<SitemapListingsResponse>>}
+     *
+     * @example
+     * const { data } = await sdk.sitemapData.queryListings();
+     * // Generate sitemap URLs from listing IDs
+     * data.data.forEach(listing => {
+     *   console.log(`/l/${listing.id}`);
+     * });
+     */
+    queryListings(): Promise<AxiosResponse<SitemapListingsResponse>>;
+    /**
+     * Query CMS asset paths for sitemap generation
+     *
+     * Returns pages created in Sharetribe Console.
+     * Excludes pages with built-in or custom paths.
+     *
+     * @returns {Promise<AxiosResponse<SitemapAssetsResponse>>}
+     *
+     * @example
+     * const { data } = await sdk.sitemapData.queryAssets();
+     * // Generate sitemap URLs from asset paths
+     * data.data.forEach(asset => {
+     *   console.log(`/p/${asset.attributes.assetPath}`);
+     * });
+     */
+    queryAssets(): Promise<AxiosResponse<SitemapAssetsResponse>>;
+}
+export default SitemapData;
+//# sourceMappingURL=SitemapData.d.ts.map

package/dist/types/endpoints/marketplace/SitemapData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SitemapData.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/SitemapData.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EAAC,qBAAqB,EAAE,uBAAuB,EAAC,MAAM,qCAAqC,CAAC;AAEnG;;;;;GAKG;AACH,cAAM,WAAW;IACf,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;;;OAeG;IACG,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;IAMtE;;;;;;;;;;;;;;OAcG;IACG,WAAW,IAAI,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;CAKnE;AAED,eAAe,WAAW,CAAC"}

package/dist/types/endpoints/marketplace/Stock.d.ts

@@ -1,47 +1,51 @@
 /**
- * @fileoverview Provides the Stock class for managing stock levels in the Sharetribe Marketplace API.
- * This class includes methods for comparing and setting stock levels.
+ * @fileoverview Client for managing listing stock in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#stock
+ * Use this to safely update stock levels using atomic compare-and-set operations.
+ * Prevents race conditions when multiple users try to book simultaneously.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#stock
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { StockCompareAndSetParameter, StockResponse } from "../../types/marketplace/stock";
-import { ExtraParameter } from "../../types/sharetribe";
+import { ExtraParameter, StockCompareAndSetParameter, StockResponse } from "../../types";
 /**
- * Class representing the Stock API.
- *
- * The Stock API provides methods for comparing and setting stock levels for marketplace resources.
+ * Stock API client (own listings only)
  */
 declare class Stock {
-    private readonly endpoint;
-    private readonly axios;
     readonly authRequired = true;
-    /**
-     * Creates an instance of the Stock class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
+    private readonly axios;
+    private readonly endpoint;
+    private readonly headers;
     constructor(api: MarketplaceApi);
     /**
-     * Compares and sets stock levels for a specific resource.
+     * Atomically update stock using compare-and-set
+     *
+     * Fails if current stock doesn't match `oldTotal` — prevents overselling.
      *
      * @template P
      * @template EP
-     * @param {P & StockCompareAndSetParameter} params - Parameters for comparing and setting stock levels.
-     * @param {EP} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<StockResponse<'compareAndSet', EP>>>} - A promise resolving to the result of the stock comparison and update.
+     * @param {P & StockCompareAndSetParameter} params
+     * @param {EP} [extraParams] - Optional extra parameters (e.g. `expand: true`)
+     * @returns {Promise<AxiosResponse<StockResponse<"compareAndSet", EP>>>}
      *
      * @example
-     * const response = await sdk.stock.compareAndSet({
-     *   listingId: 'listing-1',
+     * // Reserve 2 units if current stock is 10
+     * await sdk.stock.compareAndSet({
+     *   listingId: "listing-abc123",
      *   oldTotal: 10,
-     *   newTotal: 100
+     *   newTotal: 8
+     * });
+     *
+     * @example
+     * // Restock from 5 to 50
+     * await sdk.stock.compareAndSet({
+     *   listingId: "listing-abc123",
+     *   oldTotal: 5,
+     *   newTotal: 50
      * });
-     * const stockUpdateResult = response.data;
      */
-    compareAndSet<P extends StockCompareAndSetParameter, EP extends ExtraParameter>(params: P, extraParams?: EP | void): Promise<AxiosResponse<StockResponse<"compareAndSet", EP>>>;
+    compareAndSet<P extends StockCompareAndSetParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StockResponse<"compareAndSet", EP>>>;
 }
 export default Stock;
 //# sourceMappingURL=Stock.d.ts.map

package/dist/types/endpoints/marketplace/Stock.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Stock.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Stock.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,2BAA2B,EAC3B,aAAa,EACd,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,KAAK;IACT,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,SAAgB,YAAY,QAAQ;IAEpC;;;;OAIG;gBACS,GAAG,EAAE,cAAc;IAK/B;;;;;;;;;;;;;;;;OAgBG;IACG,aAAa,CACjB,CAAC,SAAS,2BAA2B,EACrC,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,GAAE,EAAE,GAAG,IAAe,GAChC,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC;CAM9D;AAED,eAAe,KAAK,CAAC"}
+{"version":3,"file":"Stock.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Stock.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EAAC,cAAc,EAAE,2BAA2B,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAExF;;GAEG;AACH,cAAM,KAAK;IACT,SAAgB,YAAY,QAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,aAAa,CACjB,CAAC,SAAS,2BAA2B,EACrC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC;CAO9D;AAED,eAAe,KAAK,CAAC"}

package/dist/types/endpoints/marketplace/StockAdjustments.d.ts

@@ -1,63 +1,65 @@
 /**
- * @fileoverview Provides the StockAdjustments class for managing stock adjustments in the Sharetribe Marketplace API.
- * This class includes methods for querying and creating stock adjustments.
+ * @fileoverview Client for managing manual stock adjustments in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#stock-adjustments
+ * Stock adjustments are used for restocking, write-offs, corrections, or any manual change
+ * that doesn’t come from a booking or reservation.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#stock-adjustments
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { StockAdjustmentsCreateParameter, StockAdjustmentsQueryParameter, StockAdjustmentsResponse } from "../../types/marketplace/stockAdjustment";
-import { ExtraParameter } from "../../types/sharetribe";
+import { ExtraParameter, StockAdjustmentsCreateParameter, StockAdjustmentsQueryParameter, StockAdjustmentsResponse } from "../../types";
 /**
- * Class representing the Stock Adjustments API.
- *
- * The Stock Adjustments API provides methods for querying and creating adjustments to stock levels.
+ * Stock Adjustments API client (own listings only)
  */
 declare class StockAdjustments {
-    private readonly endpoint;
+    readonly authRequired = true;
     private readonly axios;
+    private readonly endpoint;
     private readonly headers;
-    readonly authRequired = true;
-    /**
-     * Creates an instance of the StockAdjustments class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
     constructor(api: MarketplaceApi);
     /**
-     * Queries stock adjustments based on specified filters.
+     * Query stock adjustment history
      *
      * @template P
-     * @param {P & StockAdjustmentsQueryParameter} params - Query parameters to filter stock adjustments.
-     * @returns {Promise<AxiosResponse<StockAdjustmentsResponse<'query', P>>>} - A promise resolving to the query results.
+     * @param {P & StockAdjustmentsQueryParameter} params
+     * @returns {Promise<AxiosResponse<StockAdjustmentsResponse<"query", P>>>}
      *
      * @example
-     * const response = await sdk.stockAdjustments.query({
-     *   listingId: 'listing-id',
-     *   start: new Date('2022-01-01'),
-     *   end: new Date('2022-01-31'),
+     * const { data } = await sdk.stockAdjustments.query({
+     *   listingId: "listing-abc123",
+     *   start: "2025-01-01",
+     *   end: "2025-01-31"
      * });
-     * const stockAdjustments = response.data;
      */
     query<P extends StockAdjustmentsQueryParameter>(params: P): Promise<AxiosResponse<StockAdjustmentsResponse<"query", P>>>;
     /**
-     * Creates a stock adjustment for a specific resource.
+     * Create a manual stock adjustment
+     *
+     * Positive quantity → add stock
+     * Negative quantity → remove stock
      *
      * @template P
      * @template EP
-     * @param {P & StockAdjustmentsCreateParameter} params - Parameters for the stock adjustment.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<StockAdjustmentsResponse<'create', P, EP>>>} - A promise resolving to the created stock adjustment details.
+     * @param {P & StockAdjustmentsCreateParameter} params
+     * @param {EP} [extraParams] - Optional extra parameters (e.g. `expand: true`)
+     * @returns {Promise<AxiosResponse<StockAdjustmentsResponse<"create", P, EP>>>}
+     *
+     * @example
+     * // Restock 50 units
+     * await sdk.stockAdjustments.create({
+     *   listingId: "listing-abc123",
+     *   quantity: 50
+     * });
      *
      * @example
-     * const response = await sdk.stockAdjustments.create({
-     *   listingId: 'listing-id',
-     *   quantity: 5,
+     * // Write off 3 damaged units
+     * await sdk.stockAdjustments.create({
+     *   listingId: "listing-abc123",
+     *   quantity: -3
      * });
-     * const createdAdjustment = response.data;
      */
-    create<P extends StockAdjustmentsCreateParameter, EP extends ExtraParameter | undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StockAdjustmentsResponse<"create", P, EP>>>;
+    create<P extends StockAdjustmentsCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StockAdjustmentsResponse<"create", P, EP>>>;
 }
 export default StockAdjustments;
 //# sourceMappingURL=StockAdjustments.d.ts.map

package/dist/types/endpoints/marketplace/StockAdjustments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StockAdjustments.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/StockAdjustments.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,+BAA+B,EAC/B,8BAA8B,EAC9B,wBAAwB,EACzB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,gBAAgB;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,SAAgB,YAAY,QAAQ;IAEpC;;;;OAIG;gBACS,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;;OAcG;IACG,KAAK,CAAC,CAAC,SAAS,8BAA8B,EAClD,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAU/D;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACV,CAAC,SAAS,+BAA+B,EACzC,EAAE,SAAS,cAAc,GAAG,SAAS,EAErC,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;CAOrE;AAED,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"StockAdjustments.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/StockAdjustments.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,cAAc,EACd,+BAA+B,EAC/B,8BAA8B,EAC9B,wBAAwB,EACzB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,cAAM,gBAAgB;IACpB,SAAgB,YAAY,QAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;OAaG;IACG,KAAK,CAAC,CAAC,SAAS,8BAA8B,EAClD,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAO/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,MAAM,CACV,CAAC,SAAS,+BAA+B,EACzC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;CAOrE;AAED,eAAe,gBAAgB,CAAC"}

package/dist/types/endpoints/marketplace/StripeAccount.d.ts

@@ -1,78 +1,57 @@
 /**
- * @fileoverview Provides the StripeAccount class for managing Stripe accounts in the Sharetribe Marketplace API.
- * This class includes methods for fetching, creating, and updating Stripe accounts.
+ * @fileoverview Client for managing the current user's Stripe account in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#stripe-account
+ * Use this to:
+ * - Fetch existing Stripe account status
+ * - Create a new Stripe Connect account
+ * - Update account details or capabilities
+ *
+ * Requires authentication.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#stripe-account
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { StripeAccountCreateParameter, StripeAccountResponse, StripeAccountUpdateParameter } from "../../types/marketplace/stripeAccount";
-import { ExtraParameter } from "../../types/sharetribe";
+import { ExtraParameter, StripeAccountCreateParameter, StripeAccountResponse, StripeAccountUpdateParameter } from "../../types";
 /**
- * Class representing the Stripe Account API.
- *
- * The Stripe Account API provides methods for managing Stripe accounts associated with the marketplace.
+ * Stripe Account API client (current user)
  */
 declare class StripeAccount {
-    private readonly endpoint;
+    readonly authRequired = true;
     private readonly axios;
+    private readonly endpoint;
     private readonly headers;
-    readonly authRequired = true;
-    /**
-     * Creates an instance of the StripeAccount class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
     constructor(api: MarketplaceApi);
     /**
-     * Fetches the current Stripe account details.
+     * Fetch current user's Stripe account
      *
-     * @returns {Promise<AxiosResponse<StripeAccountResponse<'fetch'>>>} - A promise resolving to the Stripe account details.
+     * @returns {Promise<AxiosResponse<StripeAccountResponse<"fetch">>>}
      *
      * @example
-     * const response = await sdk.stripeAccount.fetch();
-     * const stripeAccountDetails = response.data;
+     * const { data } = await sdk.stripeAccount.fetch();
+     * console.log(data.attributes.stripeAccountData.capabilities);
      */
     fetch(): Promise<AxiosResponse<StripeAccountResponse<"fetch">>>;
     /**
-     * Creates a new Stripe account.
+     * Create a new Stripe Connect account
      *
      * @template P
      * @template EP
-     * @param {P & StripeAccountCreateParameter} params - Parameters for creating the Stripe account.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<StripeAccountResponse<'create', EP>>>} - A promise resolving to the created Stripe account details.
-     *
-     * @example
-     * const response = await sdk.stripeAccount.create({
-     *   country: 'US',
-     *   accountToken: 'account-token',
-     *   bankAccountToken: 'bank-account-token',
-     *   businessProfileMCC: '1234',
-     *   businessProfileURL: 'https://example.com',
-     *   businessProfileProductDescription: 'Product description',
-     *   requestedCapabilities: ['card_payments', 'transfers'],
-     * });
-     * const createdStripeAccount = response.data;
+     * @param {P & StripeAccountCreateParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<StripeAccountResponse<"create", EP>>>}
      */
-    create<P extends StripeAccountCreateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeAccountResponse<"create", EP>>>;
+    create<P extends StripeAccountCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeAccountResponse<"create", EP>>>;
     /**
-     * Updates an existing Stripe account.
+     * Update existing Stripe Connect account
      *
      * @template P
      * @template EP
-     * @param {P & StripeAccountUpdateParameter} params - Parameters for updating the Stripe account.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<StripeAccountResponse<'update', EP>>>} - A promise resolving to the updated Stripe account details.
-     *
-     * @example
-     * const response = await sdk.stripeAccount.update({
-     *   accountToken: 'new-account-token',
-     * });
-     * const updatedStripeAccount = response.data;
+     * @param {P & StripeAccountUpdateParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<StripeAccountResponse<"update", EP>>>}
      */
-    update<P extends StripeAccountUpdateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeAccountResponse<"update", EP>>>;
+    update<P extends StripeAccountUpdateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeAccountResponse<"update", EP>>>;
 }
 export default StripeAccount;
 //# sourceMappingURL=StripeAccount.d.ts.map

package/dist/types/endpoints/marketplace/StripeAccount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StripeAccount.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/StripeAccount.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,aAAa;IACjB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,SAAgB,YAAY,QAAQ;IAEpC;;;;OAIG;gBACS,GAAG,EAAE,cAAc;IAM/B;;;;;;;;OAQG;IACG,KAAK,IAAI,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;IASrE;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,CAAC,SAAS,4BAA4B,EACtC,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ9D;;;;;;;;;;;;;;OAcG;IACG,MAAM,CACV,CAAC,SAAS,4BAA4B,EACtC,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;CAO/D;AAED,eAAe,aAAa,CAAC"}
+{"version":3,"file":"StripeAccount.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/StripeAccount.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,cAAc,EACd,4BAA4B,EAC5B,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,cAAM,aAAa;IACjB,SAAgB,YAAY,QAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;OAQG;IACG,KAAK,IAAI,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;IAMrE;;;;;;;;OAQG;IACG,MAAM,CACV,CAAC,SAAS,4BAA4B,EACtC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ9D;;;;;;;;OAQG;IACG,MAAM,CACV,CAAC,SAAS,4BAA4B,EACtC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;CAO/D;AAED,eAAe,aAAa,CAAC"}

package/dist/types/endpoints/marketplace/StripeAccountLinks.d.ts

@@ -1,52 +1,43 @@
 /**
- * @fileoverview Provides the StripeAccountLinks class for managing Stripe account links in the Sharetribe Marketplace API.
- * This class includes methods for creating account links to manage Stripe accounts.
+ * @fileoverview Client for creating Stripe Account Links in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#stripe-account-links
+ * Use this to generate onboarding or verification links for the current user's Stripe Connect account.
+ * The returned link redirects the user to Stripe to complete account setup or provide missing info.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#stripe-account-links
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { StripeAccountLinksCreateParameter, StripeAccountLinksResponse } from "../../types/marketplace/stripeAccountLinks";
-import { ExtraParameter } from "../../types/sharetribe";
+import { ExtraParameter, StripeAccountLinksCreateParameter, StripeAccountLinksResponse } from "../../types";
 /**
- * Class representing the Stripe Account Links API.
- *
- * The Stripe Account Links API provides methods for creating links to manage Stripe accounts, such as onboarding links.
+ * Stripe Account Links API client (current user)
  */
 declare class StripeAccountLinks {
-    private readonly endpoint;
+    readonly authRequired = true;
     private readonly axios;
+    private readonly endpoint;
     private readonly headers;
-    readonly authRequired = true;
-    /**
-     * Creates an instance of the StripeAccountLinks class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
     constructor(api: MarketplaceApi);
     /**
-     * Creates a new Stripe account link.
+     * Create a Stripe Account Link (onboarding or verification)
      *
      * @template P
      * @template EP
-     * @param {P & StripeAccountLinksCreateParameter} params - Parameters for creating the account link.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<StripeAccountLinksResponse<'create', EP>>>} - A promise resolving to the created account link details.
+     * @param {P & StripeAccountLinksCreateParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<StripeAccountLinksResponse<"create", EP>>>}
      *
      * @example
-     * const response = await sdk.stripeAccountLinks.create({
-     *   failureURL: 'https://example.com/failure',
-     *   successURL: 'https://example.com/success',
-     *   type: 'custom_account_verification',
-     *   collectionOptions: {
-     *     fields: ['currently_due', 'eventually_due'],
-     *     future_requirements: ['include', 'omit'],
-     *   },
+     * const { data } = await sdk.stripeAccountLinks.create({
+     *   failureURL: "https://yoursite.com/stripe/failure",
+     *   successURL: "https://yoursite.com/stripe/success",
+     *   type: "account_onboarding",
      * });
-     * const accountLink = response.data;
+     *
+     * // Redirect user
+     * window.location.href = data.attributes.url;
      */
-    create<P extends StripeAccountLinksCreateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeAccountLinksResponse<"create", EP>>>;
+    create<P extends StripeAccountLinksCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeAccountLinksResponse<"create", EP>>>;
 }
 export default StripeAccountLinks;
 //# sourceMappingURL=StripeAccountLinks.d.ts.map

package/dist/types/endpoints/marketplace/StripeAccountLinks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StripeAccountLinks.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/StripeAccountLinks.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,iCAAiC,EACjC,0BAA0B,EAC3B,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,kBAAkB;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,SAAgB,YAAY,QAAQ;IAEpC;;;;OAIG;gBACS,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACV,CAAC,SAAS,iCAAiC,EAC3C,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,0BAA0B,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;CAOpE;AAED,eAAe,kBAAkB,CAAC"}
+{"version":3,"file":"StripeAccountLinks.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/StripeAccountLinks.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EAAC,cAAc,EAAE,iCAAiC,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAE3G;;GAEG;AACH,cAAM,kBAAkB;IACtB,SAAgB,YAAY,QAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CACV,CAAC,SAAS,iCAAiC,EAC3C,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,0BAA0B,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;CAOpE;AAED,eAAe,kBAAkB,CAAC"}