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

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

@@ -0,0 +1,60 @@
+/**
+ * @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;

package/dist/endpoints/marketplace/index.d.ts

@@ -32,6 +32,7 @@ import OwnListings from "./OwnListings";
 import PasswordReset from "./PasswordReset";
 import ProcessTransitions from "./ProcessTransitions";
 import Reviews from "./Reviews";
+import SitemapData from "./SitemapData";
 import Stock from "./Stock";
 import StockAdjustments from "./StockAdjustments";
 import StripeAccount from "./StripeAccount";
@@ -65,6 +66,7 @@ declare class MarketplaceApi {
     readonly passwordReset: PasswordReset;
     readonly processTransitions: ProcessTransitions;
     readonly reviews: Reviews;
+    readonly sitemapData: SitemapData;
     readonly stock: Stock;
     readonly stockAdjustments: StockAdjustments;
     readonly stripeAccount: StripeAccount;