@vansite/ts-sharetribe-flex-sdk 1.0.33 → 2.0.0
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/README.md +1 -1
- package/dist/endpoints/assets/index.d.ts +47 -0
- package/dist/endpoints/auth/index.d.ts +45 -0
- package/dist/endpoints/integrationApi/AvailabilityExceptions.d.ts +66 -0
- package/dist/endpoints/integrationApi/Events.d.ts +43 -0
- package/dist/endpoints/integrationApi/Images.d.ts +36 -0
- package/dist/endpoints/integrationApi/Listings.d.ts +87 -0
- package/dist/endpoints/integrationApi/Marketplace.d.ts +30 -0
- package/dist/endpoints/integrationApi/Stock.d.ts +42 -0
- package/dist/endpoints/integrationApi/StockAdjustments.d.ts +64 -0
- package/dist/{types/endpoints/integrationApi/StockReservation.d.ts → endpoints/integrationApi/StockReservations.d.ts} +3 -4
- package/dist/endpoints/integrationApi/Transactions.d.ts +76 -0
- package/dist/endpoints/integrationApi/Users.d.ts +72 -0
- package/dist/endpoints/integrationApi/index.d.ts +58 -0
- package/dist/endpoints/marketplace/AvailabilityExceptions.d.ts +69 -0
- package/dist/endpoints/marketplace/Bookings.d.ts +45 -0
- package/dist/endpoints/marketplace/CurrentUser.d.ts +110 -0
- package/dist/endpoints/marketplace/Images.d.ts +38 -0
- package/dist/endpoints/marketplace/Listings.d.ts +52 -0
- package/dist/endpoints/marketplace/Marketplace.d.ts +33 -0
- package/dist/endpoints/marketplace/Messages.d.ts +51 -0
- package/dist/endpoints/marketplace/OwnListings.d.ts +116 -0
- package/dist/endpoints/marketplace/PasswordReset.d.ts +50 -0
- package/dist/endpoints/marketplace/ProcessTransitions.d.ts +42 -0
- package/dist/endpoints/marketplace/Reviews.d.ts +49 -0
- package/dist/endpoints/marketplace/Stock.d.ts +50 -0
- package/dist/endpoints/marketplace/StockAdjustments.d.ts +64 -0
- package/dist/endpoints/marketplace/StripeAccount.d.ts +56 -0
- package/dist/endpoints/marketplace/StripeAccountLinks.d.ts +42 -0
- package/dist/endpoints/marketplace/StripeCustomer.d.ts +62 -0
- package/dist/endpoints/marketplace/StripePersons.d.ts +37 -0
- package/dist/endpoints/marketplace/StripeSetupIntents.d.ts +42 -0
- package/dist/endpoints/marketplace/TimeSlots.d.ts +40 -0
- package/dist/endpoints/marketplace/Transactions.d.ts +89 -0
- package/dist/endpoints/marketplace/Users.d.ts +34 -0
- package/dist/endpoints/marketplace/index.d.ts +80 -0
- package/dist/index.d.ts +161 -0
- package/dist/index.js +3 -0
- package/dist/{ts-sharetribe-flex-sdk.cjs.LICENSE.txt → index.js.LICENSE.txt} +53 -41
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +3 -0
- package/dist/{ts-sharetribe-flex-sdk.js.LICENSE.txt → index.mjs.LICENSE.txt} +13 -5
- package/dist/index.mjs.map +1 -0
- package/dist/index.umd.js +3 -0
- package/dist/{ts-sharetribe-flex-sdk.mjs.LICENSE.txt → index.umd.js.LICENSE.txt} +13 -5
- package/dist/index.umd.js.map +1 -0
- package/dist/integrationSdk.d.ts +119 -0
- package/dist/sdk.d.ts +211 -0
- package/dist/sdkTypes/BigDecimal.d.ts +30 -0
- package/dist/sdkTypes/LatLng.d.ts +34 -0
- package/dist/sdkTypes/LatLngBounds.d.ts +51 -0
- package/dist/sdkTypes/Money.d.ts +28 -0
- package/dist/sdkTypes/UUID.d.ts +38 -0
- package/dist/types/apiConfigs.d.ts +104 -0
- package/dist/types/assets/index.d.ts +101 -0
- package/dist/types/authentication/index.d.ts +152 -0
- package/dist/types/axios.d.ts +10 -0
- package/dist/types/config.d.ts +99 -0
- package/dist/types/endpoints/assets/index.d.ts +22 -36
- package/dist/types/endpoints/assets/index.d.ts.map +1 -1
- package/dist/types/endpoints/auth/index.d.ts +20 -41
- package/dist/types/endpoints/auth/index.d.ts.map +1 -1
- package/dist/types/endpoints/integrationApi/AvailabilityExceptions.d.ts +30 -49
- package/dist/types/endpoints/integrationApi/AvailabilityExceptions.d.ts.map +1 -1
- package/dist/types/endpoints/integrationApi/Events.d.ts +23 -27
- package/dist/types/endpoints/integrationApi/Events.d.ts.map +1 -1
- package/dist/types/endpoints/integrationApi/Images.d.ts +17 -28
- package/dist/types/endpoints/integrationApi/Images.d.ts.map +1 -1
- package/dist/types/endpoints/integrationApi/Listings.d.ts +42 -104
- package/dist/types/endpoints/integrationApi/Listings.d.ts.map +1 -1
- package/dist/types/endpoints/integrationApi/Marketplace.d.ts +12 -20
- package/dist/types/endpoints/integrationApi/Marketplace.d.ts.map +1 -1
- package/dist/types/endpoints/integrationApi/Stock.d.ts +22 -28
- package/dist/types/endpoints/integrationApi/Stock.d.ts.map +1 -1
- package/dist/types/endpoints/integrationApi/StockAdjustments.d.ts +35 -35
- package/dist/types/endpoints/integrationApi/StockAdjustments.d.ts.map +1 -1
- package/dist/types/endpoints/integrationApi/StockReservations.d.ts +43 -0
- package/dist/types/endpoints/integrationApi/StockReservations.d.ts.map +1 -0
- package/dist/types/endpoints/integrationApi/Transactions.d.ts +36 -80
- package/dist/types/endpoints/integrationApi/Transactions.d.ts.map +1 -1
- package/dist/types/endpoints/integrationApi/Users.d.ts +35 -70
- package/dist/types/endpoints/integrationApi/Users.d.ts.map +1 -1
- package/dist/types/endpoints/integrationApi/index.d.ts +40 -40
- package/dist/types/endpoints/integrationApi/index.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/AvailabilityExceptions.d.ts +34 -48
- package/dist/types/endpoints/marketplace/AvailabilityExceptions.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/Bookings.d.ts +24 -23
- package/dist/types/endpoints/marketplace/Bookings.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/CurrentUser.d.ts +54 -125
- package/dist/types/endpoints/marketplace/CurrentUser.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/Images.d.ts +19 -27
- package/dist/types/endpoints/marketplace/Images.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/Listings.d.ts +26 -25
- package/dist/types/endpoints/marketplace/Listings.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/Marketplace.d.ts +15 -19
- package/dist/types/endpoints/marketplace/Marketplace.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/Messages.d.ts +24 -29
- package/dist/types/endpoints/marketplace/Messages.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/OwnListings.d.ts +55 -119
- package/dist/types/endpoints/marketplace/OwnListings.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/PasswordReset.d.ts +23 -35
- package/dist/types/endpoints/marketplace/PasswordReset.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/ProcessTransitions.d.ts +22 -22
- package/dist/types/endpoints/marketplace/ProcessTransitions.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/Reviews.d.ts +23 -25
- package/dist/types/endpoints/marketplace/Reviews.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/Stock.d.ts +30 -26
- package/dist/types/endpoints/marketplace/Stock.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/StockAdjustments.d.ts +36 -34
- package/dist/types/endpoints/marketplace/StockAdjustments.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/StripeAccount.d.ts +28 -49
- package/dist/types/endpoints/marketplace/StripeAccount.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/StripeAccountLinks.d.ts +22 -31
- package/dist/types/endpoints/marketplace/StripeAccountLinks.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/StripeCustomer.d.ts +32 -46
- package/dist/types/endpoints/marketplace/StripeCustomer.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/StripePersons.d.ts +17 -25
- package/dist/types/endpoints/marketplace/StripePersons.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/StripeSetupIntents.d.ts +24 -24
- package/dist/types/endpoints/marketplace/StripeSetupIntents.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/TimeSlots.d.ts +20 -23
- package/dist/types/endpoints/marketplace/TimeSlots.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/Transactions.d.ts +45 -81
- package/dist/types/endpoints/marketplace/Transactions.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/Users.d.ts +15 -22
- package/dist/types/endpoints/marketplace/Users.d.ts.map +1 -1
- package/dist/types/endpoints/marketplace/index.d.ts +50 -40
- package/dist/types/endpoints/marketplace/index.d.ts.map +1 -1
- package/dist/types/index.d.ts +15 -30
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/integration/events.d.ts +87 -0
- package/dist/types/integrationSdk.d.ts +4 -5
- package/dist/types/integrationSdk.d.ts.map +1 -1
- package/dist/types/marketplace/availabilityExceptions.d.ts +99 -0
- package/dist/types/marketplace/availabilityPlan.d.ts +17 -0
- package/dist/types/marketplace/bookings.d.ts +80 -0
- package/dist/types/marketplace/currentUser.d.ts +202 -0
- package/dist/types/marketplace/images.d.ts +65 -0
- package/dist/types/marketplace/listings.d.ts +169 -0
- package/dist/types/marketplace/marketplace.d.ts +30 -0
- package/dist/types/marketplace/messages.d.ts +87 -0
- package/dist/types/marketplace/ownListings.d.ts +155 -0
- package/dist/types/marketplace/passwordReset.d.ts +54 -0
- package/dist/types/marketplace/processTransitions.d.ts +56 -0
- package/dist/types/marketplace/reviews.d.ts +108 -0
- package/dist/types/marketplace/stock.d.ts +45 -0
- package/dist/types/marketplace/stockAdjustment.d.ts +97 -0
- package/dist/types/marketplace/stockReservations.d.ts +89 -0
- package/dist/types/marketplace/stripeAccount.d.ts +67 -0
- package/dist/types/marketplace/stripeAccountLinks.d.ts +55 -0
- package/dist/types/marketplace/stripeCustomer.d.ts +94 -0
- package/dist/types/marketplace/stripePaymentMethod.d.ts +21 -0
- package/dist/types/marketplace/stripePersons.d.ts +48 -0
- package/dist/types/marketplace/stripeSetupIntents.d.ts +48 -0
- package/dist/types/marketplace/timeSlots.d.ts +51 -0
- package/dist/types/marketplace/transactions.d.ts +200 -0
- package/dist/types/marketplace/user.d.ts +200 -0
- package/dist/types/sdk-types.d.ts +10 -0
- package/dist/types/sdk.d.ts +6 -7
- package/dist/types/sdk.d.ts.map +1 -1
- package/dist/types/sdkTypes/BigDecimal.d.ts +1 -1
- package/dist/types/sdkTypes/BigDecimal.d.ts.map +1 -1
- package/dist/types/sdkTypes/LatLng.d.ts +1 -1
- package/dist/types/sdkTypes/LatLng.d.ts.map +1 -1
- package/dist/types/sdkTypes/LatLngBounds.d.ts +1 -1
- package/dist/types/sdkTypes/LatLngBounds.d.ts.map +1 -1
- package/dist/types/sdkTypes/Money.d.ts +1 -1
- package/dist/types/sdkTypes/Money.d.ts.map +1 -1
- package/dist/types/sdkTypes/UUID.d.ts +1 -1
- package/dist/types/sdkTypes/UUID.d.ts.map +1 -1
- package/dist/types/sharetribe.d.ts +227 -0
- package/dist/types/store.d.ts +22 -0
- package/dist/types/types/apiConfigs.d.ts.map +1 -1
- package/dist/types/types/assets/index.d.ts +74 -36
- package/dist/types/types/assets/index.d.ts.map +1 -1
- package/dist/types/types/authentication/index.d.ts +111 -60
- package/dist/types/types/authentication/index.d.ts.map +1 -1
- package/dist/types/types/axios.d.ts.map +1 -1
- package/dist/types/types/config.d.ts +1 -39
- package/dist/types/types/config.d.ts.map +1 -1
- package/dist/types/types/integration/events.d.ts +52 -20
- package/dist/types/types/integration/events.d.ts.map +1 -1
- package/dist/types/types/marketplace/availabilityExceptions.d.ts +59 -16
- package/dist/types/types/marketplace/availabilityExceptions.d.ts.map +1 -1
- package/dist/types/types/marketplace/availabilityPlan.d.ts +18 -0
- package/dist/types/types/marketplace/availabilityPlan.d.ts.map +1 -0
- package/dist/types/types/marketplace/bookings.d.ts +48 -14
- package/dist/types/types/marketplace/bookings.d.ts.map +1 -1
- package/dist/types/types/marketplace/currentUser.d.ts +99 -55
- package/dist/types/types/marketplace/currentUser.d.ts.map +1 -1
- package/dist/types/types/marketplace/images.d.ts +40 -14
- package/dist/types/types/marketplace/images.d.ts.map +1 -1
- package/dist/types/types/marketplace/listings.d.ts +96 -66
- package/dist/types/types/marketplace/listings.d.ts.map +1 -1
- package/dist/types/types/marketplace/marketplace.d.ts +16 -6
- package/dist/types/types/marketplace/marketplace.d.ts.map +1 -1
- package/dist/types/types/marketplace/messages.d.ts +53 -15
- package/dist/types/types/marketplace/messages.d.ts.map +1 -1
- package/dist/types/types/marketplace/ownListings.d.ts +92 -65
- package/dist/types/types/marketplace/ownListings.d.ts.map +1 -1
- package/dist/types/types/marketplace/passwordReset.d.ts +32 -9
- package/dist/types/types/marketplace/passwordReset.d.ts.map +1 -1
- package/dist/types/types/marketplace/processTransitions.d.ts +33 -14
- package/dist/types/types/marketplace/processTransitions.d.ts.map +1 -1
- package/dist/types/types/marketplace/reviews.d.ts +72 -23
- package/dist/types/types/marketplace/reviews.d.ts.map +1 -1
- package/dist/types/types/marketplace/stock.d.ts +23 -6
- package/dist/types/types/marketplace/stock.d.ts.map +1 -1
- package/dist/types/types/marketplace/stockAdjustment.d.ts +60 -14
- package/dist/types/types/marketplace/stockAdjustment.d.ts.map +1 -1
- package/dist/types/types/marketplace/stockReservations.d.ts +59 -14
- package/dist/types/types/marketplace/stockReservations.d.ts.map +1 -1
- package/dist/types/types/marketplace/stripeAccount.d.ts +28 -5
- package/dist/types/types/marketplace/stripeAccount.d.ts.map +1 -1
- package/dist/types/types/marketplace/stripeAccountLinks.d.ts +26 -6
- package/dist/types/types/marketplace/stripeAccountLinks.d.ts.map +1 -1
- package/dist/types/types/marketplace/stripeCustomer.d.ts +60 -13
- package/dist/types/types/marketplace/stripeCustomer.d.ts.map +1 -1
- package/dist/types/types/marketplace/stripePaymentMethod.d.ts +1 -2
- package/dist/types/types/marketplace/stripePaymentMethod.d.ts.map +1 -1
- package/dist/types/types/marketplace/stripePersons.d.ts +17 -15
- package/dist/types/types/marketplace/stripePersons.d.ts.map +1 -1
- package/dist/types/types/marketplace/stripeSetupIntents.d.ts +16 -14
- package/dist/types/types/marketplace/stripeSetupIntents.d.ts.map +1 -1
- package/dist/types/types/marketplace/timeSlots.d.ts +13 -15
- package/dist/types/types/marketplace/timeSlots.d.ts.map +1 -1
- package/dist/types/types/marketplace/transactions.d.ts +77 -83
- package/dist/types/types/marketplace/transactions.d.ts.map +1 -1
- package/dist/types/types/marketplace/user.d.ts +85 -64
- package/dist/types/types/marketplace/user.d.ts.map +1 -1
- package/dist/types/types/sharetribe.d.ts +130 -92
- package/dist/types/types/sharetribe.d.ts.map +1 -1
- package/dist/types/types/store.d.ts +3 -14
- package/dist/types/types/store.d.ts.map +1 -1
- package/dist/types/utils/apis.d.ts +1 -1
- package/dist/types/utils/apis.d.ts.map +1 -1
- package/dist/types/utils/config.d.ts.map +1 -1
- package/dist/types/utils/convert-types.d.ts.map +1 -1
- package/dist/types/utils/parameter-serializer.d.ts.map +1 -1
- package/dist/types/utils/prepare-axios-instance.d.ts +1 -1
- package/dist/types/utils/prepare-axios-instance.d.ts.map +1 -1
- package/dist/types/utils/stores/BrowserStore.d.ts +1 -2
- package/dist/types/utils/stores/BrowserStore.d.ts.map +1 -1
- package/dist/types/utils/stores/ExpressStore.d.ts +6 -7
- package/dist/types/utils/stores/ExpressStore.d.ts.map +1 -1
- package/dist/types/utils/stores/MemoryStore.d.ts +1 -2
- package/dist/types/utils/stores/MemoryStore.d.ts.map +1 -1
- package/dist/types/utils/stores/store.d.ts.map +1 -1
- package/dist/types/utils/transit.d.ts +1 -1
- package/dist/types/utils/transit.d.ts.map +1 -1
- package/dist/types/utils/util.d.ts +2 -2
- package/dist/types/utils/util.d.ts.map +1 -1
- package/dist/utils/apis.d.ts +8 -0
- package/dist/utils/config.d.ts +32 -0
- package/dist/utils/convert-types.d.ts +13 -0
- package/dist/utils/parameter-serializer.d.ts +23 -0
- package/dist/utils/prepare-axios-instance.d.ts +14 -0
- package/dist/utils/stores/BrowserStore.d.ts +37 -0
- package/dist/utils/stores/ExpressStore.d.ts +48 -0
- package/dist/utils/stores/MemoryStore.d.ts +23 -0
- package/dist/utils/stores/store.d.ts +8 -0
- package/dist/utils/transit.d.ts +28 -0
- package/dist/utils/util.d.ts +15 -0
- package/package.json +18 -17
- package/dist/ts-sharetribe-flex-sdk.cjs +0 -3
- package/dist/ts-sharetribe-flex-sdk.cjs.map +0 -1
- package/dist/ts-sharetribe-flex-sdk.js +0 -3
- package/dist/ts-sharetribe-flex-sdk.js.map +0 -1
- package/dist/ts-sharetribe-flex-sdk.mjs +0 -3
- package/dist/ts-sharetribe-flex-sdk.mjs.map +0 -1
- package/dist/types/endpoints/integrationApi/StockReservation.d.ts.map +0 -1
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for querying reviews in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* Use this to fetch your own reviews or reviews for listings you own.
|
|
5
|
+
* Only returns reviews the current user is authorized to see.
|
|
6
|
+
*
|
|
7
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#reviews
|
|
8
|
+
*/
|
|
9
|
+
import type { AxiosResponse } from "axios";
|
|
10
|
+
import MarketplaceApi from "./index";
|
|
11
|
+
import { ReviewsQueryParameter, ReviewsResponse, ReviewsShowParameter } from "../../types";
|
|
12
|
+
/**
|
|
13
|
+
* Reviews API client (own reviews only)
|
|
14
|
+
*/
|
|
15
|
+
declare class Reviews {
|
|
16
|
+
readonly authRequired = true;
|
|
17
|
+
private readonly axios;
|
|
18
|
+
private readonly endpoint;
|
|
19
|
+
private readonly headers;
|
|
20
|
+
constructor(api: MarketplaceApi);
|
|
21
|
+
/**
|
|
22
|
+
* Fetch a single review by ID
|
|
23
|
+
*
|
|
24
|
+
* @template P
|
|
25
|
+
* @param {P & ReviewsShowParameter} params
|
|
26
|
+
* @returns {Promise<AxiosResponse<ReviewsResponse<"show", P>>>}
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* const { data } = await sdk.reviews.show({ id: "rev-abc123" });
|
|
30
|
+
*/
|
|
31
|
+
show<P extends ReviewsShowParameter>(params: P): Promise<AxiosResponse<ReviewsResponse<"show", P>>>;
|
|
32
|
+
/**
|
|
33
|
+
* Query your own reviews or reviews for your listings
|
|
34
|
+
*
|
|
35
|
+
* @template P
|
|
36
|
+
* @param {P & ReviewsQueryParameter} params
|
|
37
|
+
* @returns {Promise<AxiosResponse<ReviewsResponse<"query", P>>>}
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* // All reviews you've received
|
|
41
|
+
* const { data } = await sdk.reviews.query({ subjectId: "current" });
|
|
42
|
+
*
|
|
43
|
+
* @example
|
|
44
|
+
* // Reviews for one of your listings
|
|
45
|
+
* await sdk.reviews.query({ listingId: "listing-abc123" });
|
|
46
|
+
*/
|
|
47
|
+
query<P extends ReviewsQueryParameter>(params: P): Promise<AxiosResponse<ReviewsResponse<"query", P>>>;
|
|
48
|
+
}
|
|
49
|
+
export default Reviews;
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for managing listing stock in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* Use this to safely update stock levels using atomic compare-and-set operations.
|
|
5
|
+
* Prevents race conditions when multiple users try to book simultaneously.
|
|
6
|
+
*
|
|
7
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#stock
|
|
8
|
+
*/
|
|
9
|
+
import type { AxiosResponse } from "axios";
|
|
10
|
+
import MarketplaceApi from "./index";
|
|
11
|
+
import { ExtraParameter, StockCompareAndSetParameter, StockResponse } from "../../types";
|
|
12
|
+
/**
|
|
13
|
+
* Stock API client (own listings only)
|
|
14
|
+
*/
|
|
15
|
+
declare class Stock {
|
|
16
|
+
readonly authRequired = true;
|
|
17
|
+
private readonly axios;
|
|
18
|
+
private readonly endpoint;
|
|
19
|
+
private readonly headers;
|
|
20
|
+
constructor(api: MarketplaceApi);
|
|
21
|
+
/**
|
|
22
|
+
* Atomically update stock using compare-and-set
|
|
23
|
+
*
|
|
24
|
+
* Fails if current stock doesn't match `oldTotal` — prevents overselling.
|
|
25
|
+
*
|
|
26
|
+
* @template P
|
|
27
|
+
* @template EP
|
|
28
|
+
* @param {P & StockCompareAndSetParameter} params
|
|
29
|
+
* @param {EP} [extraParams] - Optional extra parameters (e.g. `expand: true`)
|
|
30
|
+
* @returns {Promise<AxiosResponse<StockResponse<"compareAndSet", EP>>>}
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* // Reserve 2 units if current stock is 10
|
|
34
|
+
* await sdk.stock.compareAndSet({
|
|
35
|
+
* listingId: "listing-abc123",
|
|
36
|
+
* oldTotal: 10,
|
|
37
|
+
* newTotal: 8
|
|
38
|
+
* });
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* // Restock from 5 to 50
|
|
42
|
+
* await sdk.stock.compareAndSet({
|
|
43
|
+
* listingId: "listing-abc123",
|
|
44
|
+
* oldTotal: 5,
|
|
45
|
+
* newTotal: 50
|
|
46
|
+
* });
|
|
47
|
+
*/
|
|
48
|
+
compareAndSet<P extends StockCompareAndSetParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StockResponse<"compareAndSet", EP>>>;
|
|
49
|
+
}
|
|
50
|
+
export default Stock;
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for managing manual stock adjustments in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* Stock adjustments are used for restocking, write-offs, corrections, or any manual change
|
|
5
|
+
* that doesn’t come from a booking or reservation.
|
|
6
|
+
*
|
|
7
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#stock-adjustments
|
|
8
|
+
*/
|
|
9
|
+
import type { AxiosResponse } from "axios";
|
|
10
|
+
import MarketplaceApi from "./index";
|
|
11
|
+
import { ExtraParameter, StockAdjustmentsCreateParameter, StockAdjustmentsQueryParameter, StockAdjustmentsResponse } from "../../types";
|
|
12
|
+
/**
|
|
13
|
+
* Stock Adjustments API client (own listings only)
|
|
14
|
+
*/
|
|
15
|
+
declare class StockAdjustments {
|
|
16
|
+
readonly authRequired = true;
|
|
17
|
+
private readonly axios;
|
|
18
|
+
private readonly endpoint;
|
|
19
|
+
private readonly headers;
|
|
20
|
+
constructor(api: MarketplaceApi);
|
|
21
|
+
/**
|
|
22
|
+
* Query stock adjustment history
|
|
23
|
+
*
|
|
24
|
+
* @template P
|
|
25
|
+
* @param {P & StockAdjustmentsQueryParameter} params
|
|
26
|
+
* @returns {Promise<AxiosResponse<StockAdjustmentsResponse<"query", P>>>}
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* const { data } = await sdk.stockAdjustments.query({
|
|
30
|
+
* listingId: "listing-abc123",
|
|
31
|
+
* start: "2025-01-01",
|
|
32
|
+
* end: "2025-01-31"
|
|
33
|
+
* });
|
|
34
|
+
*/
|
|
35
|
+
query<P extends StockAdjustmentsQueryParameter>(params: P): Promise<AxiosResponse<StockAdjustmentsResponse<"query", P>>>;
|
|
36
|
+
/**
|
|
37
|
+
* Create a manual stock adjustment
|
|
38
|
+
*
|
|
39
|
+
* Positive quantity → add stock
|
|
40
|
+
* Negative quantity → remove stock
|
|
41
|
+
*
|
|
42
|
+
* @template P
|
|
43
|
+
* @template EP
|
|
44
|
+
* @param {P & StockAdjustmentsCreateParameter} params
|
|
45
|
+
* @param {EP} [extraParams] - Optional extra parameters (e.g. `expand: true`)
|
|
46
|
+
* @returns {Promise<AxiosResponse<StockAdjustmentsResponse<"create", P, EP>>>}
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* // Restock 50 units
|
|
50
|
+
* await sdk.stockAdjustments.create({
|
|
51
|
+
* listingId: "listing-abc123",
|
|
52
|
+
* quantity: 50
|
|
53
|
+
* });
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* // Write off 3 damaged units
|
|
57
|
+
* await sdk.stockAdjustments.create({
|
|
58
|
+
* listingId: "listing-abc123",
|
|
59
|
+
* quantity: -3
|
|
60
|
+
* });
|
|
61
|
+
*/
|
|
62
|
+
create<P extends StockAdjustmentsCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StockAdjustmentsResponse<"create", P, EP>>>;
|
|
63
|
+
}
|
|
64
|
+
export default StockAdjustments;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for managing the current user's Stripe account in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* Use this to:
|
|
5
|
+
* - Fetch existing Stripe account status
|
|
6
|
+
* - Create a new Stripe Connect account
|
|
7
|
+
* - Update account details or capabilities
|
|
8
|
+
*
|
|
9
|
+
* Requires authentication.
|
|
10
|
+
*
|
|
11
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#stripe-account
|
|
12
|
+
*/
|
|
13
|
+
import type { AxiosResponse } from "axios";
|
|
14
|
+
import MarketplaceApi from "./index";
|
|
15
|
+
import { ExtraParameter, StripeAccountCreateParameter, StripeAccountResponse, StripeAccountUpdateParameter } from "../../types";
|
|
16
|
+
/**
|
|
17
|
+
* Stripe Account API client (current user)
|
|
18
|
+
*/
|
|
19
|
+
declare class StripeAccount {
|
|
20
|
+
readonly authRequired = true;
|
|
21
|
+
private readonly axios;
|
|
22
|
+
private readonly endpoint;
|
|
23
|
+
private readonly headers;
|
|
24
|
+
constructor(api: MarketplaceApi);
|
|
25
|
+
/**
|
|
26
|
+
* Fetch current user's Stripe account
|
|
27
|
+
*
|
|
28
|
+
* @returns {Promise<AxiosResponse<StripeAccountResponse<"fetch">>>}
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* const { data } = await sdk.stripeAccount.fetch();
|
|
32
|
+
* console.log(data.attributes.stripeAccountData.capabilities);
|
|
33
|
+
*/
|
|
34
|
+
fetch(): Promise<AxiosResponse<StripeAccountResponse<"fetch">>>;
|
|
35
|
+
/**
|
|
36
|
+
* Create a new Stripe Connect account
|
|
37
|
+
*
|
|
38
|
+
* @template P
|
|
39
|
+
* @template EP
|
|
40
|
+
* @param {P & StripeAccountCreateParameter} params
|
|
41
|
+
* @param {EP} [extraParams]
|
|
42
|
+
* @returns {Promise<AxiosResponse<StripeAccountResponse<"create", EP>>>}
|
|
43
|
+
*/
|
|
44
|
+
create<P extends StripeAccountCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeAccountResponse<"create", EP>>>;
|
|
45
|
+
/**
|
|
46
|
+
* Update existing Stripe Connect account
|
|
47
|
+
*
|
|
48
|
+
* @template P
|
|
49
|
+
* @template EP
|
|
50
|
+
* @param {P & StripeAccountUpdateParameter} params
|
|
51
|
+
* @param {EP} [extraParams]
|
|
52
|
+
* @returns {Promise<AxiosResponse<StripeAccountResponse<"update", EP>>>}
|
|
53
|
+
*/
|
|
54
|
+
update<P extends StripeAccountUpdateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeAccountResponse<"update", EP>>>;
|
|
55
|
+
}
|
|
56
|
+
export default StripeAccount;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for creating Stripe Account Links in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* Use this to generate onboarding or verification links for the current user's Stripe Connect account.
|
|
5
|
+
* The returned link redirects the user to Stripe to complete account setup or provide missing info.
|
|
6
|
+
*
|
|
7
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#stripe-account-links
|
|
8
|
+
*/
|
|
9
|
+
import type { AxiosResponse } from "axios";
|
|
10
|
+
import MarketplaceApi from "./index";
|
|
11
|
+
import { ExtraParameter, StripeAccountLinksCreateParameter, StripeAccountLinksResponse } from "../../types";
|
|
12
|
+
/**
|
|
13
|
+
* Stripe Account Links API client (current user)
|
|
14
|
+
*/
|
|
15
|
+
declare class StripeAccountLinks {
|
|
16
|
+
readonly authRequired = true;
|
|
17
|
+
private readonly axios;
|
|
18
|
+
private readonly endpoint;
|
|
19
|
+
private readonly headers;
|
|
20
|
+
constructor(api: MarketplaceApi);
|
|
21
|
+
/**
|
|
22
|
+
* Create a Stripe Account Link (onboarding or verification)
|
|
23
|
+
*
|
|
24
|
+
* @template P
|
|
25
|
+
* @template EP
|
|
26
|
+
* @param {P & StripeAccountLinksCreateParameter} params
|
|
27
|
+
* @param {EP} [extraParams]
|
|
28
|
+
* @returns {Promise<AxiosResponse<StripeAccountLinksResponse<"create", EP>>>}
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* const { data } = await sdk.stripeAccountLinks.create({
|
|
32
|
+
* failureURL: "https://yoursite.com/stripe/failure",
|
|
33
|
+
* successURL: "https://yoursite.com/stripe/success",
|
|
34
|
+
* type: "account_onboarding",
|
|
35
|
+
* });
|
|
36
|
+
*
|
|
37
|
+
* // Redirect user
|
|
38
|
+
* window.location.href = data.attributes.url;
|
|
39
|
+
*/
|
|
40
|
+
create<P extends StripeAccountLinksCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeAccountLinksResponse<"create", EP>>>;
|
|
41
|
+
}
|
|
42
|
+
export default StripeAccountLinks;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for managing the current user's Stripe Customer object in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* Use this to:
|
|
5
|
+
* - Create a Stripe Customer (required for charging users)
|
|
6
|
+
* - Attach payment methods (e.g. saved cards)
|
|
7
|
+
* - Remove payment methods
|
|
8
|
+
*
|
|
9
|
+
* All operations are performed on the current authenticated user.
|
|
10
|
+
*
|
|
11
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#stripe-customer
|
|
12
|
+
*/
|
|
13
|
+
import type { AxiosResponse } from "axios";
|
|
14
|
+
import MarketplaceApi from "./index";
|
|
15
|
+
import { ExtraParameter, StripeCustomerAddPaymentMethodParameter, StripeCustomerCreateParameter, StripeCustomerDeletePaymentMethodParameter, StripeCustomerResponse } from "../../types";
|
|
16
|
+
/**
|
|
17
|
+
* Stripe Customer API client (current user)
|
|
18
|
+
*/
|
|
19
|
+
declare class StripeCustomer {
|
|
20
|
+
readonly authRequired = true;
|
|
21
|
+
private readonly axios;
|
|
22
|
+
private readonly endpoint;
|
|
23
|
+
private readonly headers;
|
|
24
|
+
constructor(api: MarketplaceApi);
|
|
25
|
+
/**
|
|
26
|
+
* Create a Stripe Customer for the current user
|
|
27
|
+
*
|
|
28
|
+
* @template P
|
|
29
|
+
* @template EP
|
|
30
|
+
* @param {P & StripeCustomerCreateParameter} params
|
|
31
|
+
* @param {EP} [extraParams]
|
|
32
|
+
* @returns {Promise<AxiosResponse<StripeCustomerResponse<"create", P, EP>>>}
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* await sdk.stripeCustomer.create({
|
|
36
|
+
* stripePaymentMethodId: "pm_card_visa",
|
|
37
|
+
* stripeCustomerEmail: "user@example.com"
|
|
38
|
+
* });
|
|
39
|
+
*/
|
|
40
|
+
create<P extends StripeCustomerCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeCustomerResponse<"create", P, EP>>>;
|
|
41
|
+
/**
|
|
42
|
+
* Attach a new payment method to the current user's Stripe Customer
|
|
43
|
+
*
|
|
44
|
+
* @template P
|
|
45
|
+
* @template EP
|
|
46
|
+
* @param {P & StripeCustomerAddPaymentMethodParameter} params
|
|
47
|
+
* @param {EP} [extraParams]
|
|
48
|
+
* @returns {Promise<AxiosResponse<StripeCustomerResponse<"addPaymentMethod", P, EP>>>}
|
|
49
|
+
*/
|
|
50
|
+
addPaymentMethod<P extends StripeCustomerAddPaymentMethodParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeCustomerResponse<"addPaymentMethod", P, EP>>>;
|
|
51
|
+
/**
|
|
52
|
+
* Remove a saved payment method
|
|
53
|
+
*
|
|
54
|
+
* @template P
|
|
55
|
+
* @template EP
|
|
56
|
+
* @param {P & StripeCustomerDeletePaymentMethodParameter} params
|
|
57
|
+
* @param {EP} [extraParams]
|
|
58
|
+
* @returns {Promise<AxiosResponse<StripeCustomerResponse<"deletePaymentMethod", P, EP>>>}
|
|
59
|
+
*/
|
|
60
|
+
deletePaymentMethod<P extends StripeCustomerDeletePaymentMethodParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeCustomerResponse<"deletePaymentMethod", P, EP>>>;
|
|
61
|
+
}
|
|
62
|
+
export default StripeCustomer;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for creating Stripe Persons in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* A "Person" represents an individual associated with a Stripe Connect account
|
|
5
|
+
* (e.g. owner, director, representative). Required for compliance in many countries.
|
|
6
|
+
*
|
|
7
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#stripe-persons
|
|
8
|
+
*/
|
|
9
|
+
import type { AxiosResponse } from "axios";
|
|
10
|
+
import MarketplaceApi from "./index";
|
|
11
|
+
import { ExtraParameter, StripePersonsCreateParameter, StripePersonsResponse } from "../../types";
|
|
12
|
+
/**
|
|
13
|
+
* Stripe Persons API client (current user)
|
|
14
|
+
*/
|
|
15
|
+
declare class StripePersons {
|
|
16
|
+
readonly authRequired = true;
|
|
17
|
+
private readonly axios;
|
|
18
|
+
private readonly endpoint;
|
|
19
|
+
private readonly headers;
|
|
20
|
+
constructor(api: MarketplaceApi);
|
|
21
|
+
/**
|
|
22
|
+
* Create a new Person for the current user's Stripe Connect account
|
|
23
|
+
*
|
|
24
|
+
* @template P
|
|
25
|
+
* @template EP
|
|
26
|
+
* @param {P & StripePersonsCreateParameter} params
|
|
27
|
+
* @param {EP} [extraParams]
|
|
28
|
+
* @returns {Promise<AxiosResponse<StripePersonsResponse<"create">>>}
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* await sdk.stripePersons.create({
|
|
32
|
+
* personToken: "person_tok_1AbC2DeFGhiJkLMnOPqRsTuV"
|
|
33
|
+
* });
|
|
34
|
+
*/
|
|
35
|
+
create<P extends StripePersonsCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripePersonsResponse<"create">>>;
|
|
36
|
+
}
|
|
37
|
+
export default StripePersons;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for creating Stripe Setup Intents in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* A Setup Intent is used to save a payment method (e.g. card) for future use
|
|
5
|
+
* without charging immediately — ideal for marketplaces that charge later.
|
|
6
|
+
*
|
|
7
|
+
* Returns `client_secret` for use with Stripe.js / Elements.
|
|
8
|
+
*
|
|
9
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#stripe-setup-intents
|
|
10
|
+
*/
|
|
11
|
+
import type { AxiosResponse } from "axios";
|
|
12
|
+
import MarketplaceApi from "./index";
|
|
13
|
+
import { ExtraParameter, StripeSetupIntentsCreateParameter, StripeSetupIntentsResponse } from "../../types";
|
|
14
|
+
/**
|
|
15
|
+
* Stripe Setup Intents API client (current user)
|
|
16
|
+
*/
|
|
17
|
+
declare class StripeSetupIntents {
|
|
18
|
+
readonly authRequired = true;
|
|
19
|
+
private readonly axios;
|
|
20
|
+
private readonly endpoint;
|
|
21
|
+
private readonly headers;
|
|
22
|
+
constructor(api: MarketplaceApi);
|
|
23
|
+
/**
|
|
24
|
+
* Create a new Setup Intent for saving a payment method
|
|
25
|
+
*
|
|
26
|
+
* @template P
|
|
27
|
+
* @template EP
|
|
28
|
+
* @param {P & StripeSetupIntentsCreateParameter} params
|
|
29
|
+
* @param {EP} [extraParams]
|
|
30
|
+
* @returns {Promise<AxiosResponse<StripeSetupIntentsResponse<"create">>>}
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* const { data } = await sdk.stripeSetupIntents.create({});
|
|
34
|
+
*
|
|
35
|
+
* // Use with Stripe.js
|
|
36
|
+
* stripe.confirmCardSetup(data.attributes.clientSecret, {
|
|
37
|
+
* payment_method: { card: cardElement }
|
|
38
|
+
* });
|
|
39
|
+
*/
|
|
40
|
+
create<P extends StripeSetupIntentsCreateParameter, EP extends ExtraParameter | undefined = undefined>(params?: P, extraParams?: EP): Promise<AxiosResponse<StripeSetupIntentsResponse<"create">>>;
|
|
41
|
+
}
|
|
42
|
+
export default StripeSetupIntents;
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for querying time slots in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* Use this to fetch availability for listings that use time-based booking
|
|
5
|
+
* (e.g. hourly rentals, appointments, classes).
|
|
6
|
+
*
|
|
7
|
+
* Returns day or time-range slots with seat availability.
|
|
8
|
+
*
|
|
9
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#time-slots
|
|
10
|
+
*/
|
|
11
|
+
import type { AxiosResponse } from "axios";
|
|
12
|
+
import MarketplaceApi from "./index";
|
|
13
|
+
import { TimeSlotsQueryParameter, TimeSlotsResponse } from "../../types";
|
|
14
|
+
/**
|
|
15
|
+
* Time Slots API client
|
|
16
|
+
*/
|
|
17
|
+
declare class TimeSlots {
|
|
18
|
+
private readonly axios;
|
|
19
|
+
private readonly endpoint;
|
|
20
|
+
private readonly headers;
|
|
21
|
+
constructor(api: MarketplaceApi);
|
|
22
|
+
/**
|
|
23
|
+
* Query available time slots for a listing
|
|
24
|
+
*
|
|
25
|
+
* @template P
|
|
26
|
+
* @param {P & TimeSlotsQueryParameter} params
|
|
27
|
+
* @returns {Promise<AxiosResponse<TimeSlotsResponse<"query">>>}
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* const { data } = await sdk.timeSlots.query({
|
|
31
|
+
* listingId: "listing-abc123",
|
|
32
|
+
* start: "2025-06-01T00:00:00Z",
|
|
33
|
+
* end: "2025-06-07T23:59:59Z"
|
|
34
|
+
* });
|
|
35
|
+
*
|
|
36
|
+
* // `data` contains TimeSlot[] with `seats` and `start`/`end`
|
|
37
|
+
*/
|
|
38
|
+
query<P extends TimeSlotsQueryParameter>(params: P): Promise<AxiosResponse<TimeSlotsResponse<"query">>>;
|
|
39
|
+
}
|
|
40
|
+
export default TimeSlots;
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for managing transactions in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* Use this to:
|
|
5
|
+
* - Query your own transactions
|
|
6
|
+
* - Initiate new orders/inquiries
|
|
7
|
+
* - Transition transactions (accept, complete, cancel, etc.)
|
|
8
|
+
* - Perform speculative transitions (dry-run)
|
|
9
|
+
*
|
|
10
|
+
* All operations require authentication.
|
|
11
|
+
*
|
|
12
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#transactions
|
|
13
|
+
*/
|
|
14
|
+
import type { AxiosResponse } from "axios";
|
|
15
|
+
import MarketplaceApi from "./index";
|
|
16
|
+
import { ExtraParameter, TransactionsInitiateParameter, TransactionsInitiateSpeculativeParameter, TransactionsQueryParameter, TransactionsResponse, TransactionsShowParameter, TransactionsTransitionParameter, TransactionsTransitionSpeculativeParameter } from "../../types";
|
|
17
|
+
/**
|
|
18
|
+
* Transactions API client (current user)
|
|
19
|
+
*/
|
|
20
|
+
declare class Transactions {
|
|
21
|
+
readonly authRequired = true;
|
|
22
|
+
private readonly axios;
|
|
23
|
+
private readonly endpoint;
|
|
24
|
+
private readonly headers;
|
|
25
|
+
constructor(api: MarketplaceApi);
|
|
26
|
+
/**
|
|
27
|
+
* Fetch a single transaction by ID
|
|
28
|
+
*
|
|
29
|
+
* @template P
|
|
30
|
+
* @param {P & TransactionsShowParameter} params
|
|
31
|
+
* @returns {Promise<AxiosResponse<TransactionsResponse<"show", P>>>}
|
|
32
|
+
*/
|
|
33
|
+
show<P extends TransactionsShowParameter>(params: P): Promise<AxiosResponse<TransactionsResponse<"show", P>>>;
|
|
34
|
+
/**
|
|
35
|
+
* Query your own transactions
|
|
36
|
+
*
|
|
37
|
+
* @template P
|
|
38
|
+
* @param {P & TransactionsQueryParameter} params
|
|
39
|
+
* @returns {Promise<AxiosResponse<TransactionsResponse<"query", P>>>}
|
|
40
|
+
*/
|
|
41
|
+
query<P extends TransactionsQueryParameter>(params?: P): Promise<AxiosResponse<TransactionsResponse<"query", P>>>;
|
|
42
|
+
/**
|
|
43
|
+
* Initiate a new transaction (e.g. place an order)
|
|
44
|
+
*
|
|
45
|
+
* @template P
|
|
46
|
+
* @template EP
|
|
47
|
+
* @param {P & TransactionsInitiateParameter} params
|
|
48
|
+
* @param {EP} [extraParams]
|
|
49
|
+
* @returns {Promise<AxiosResponse<TransactionsResponse<"initiate", P, EP>>>}
|
|
50
|
+
*/
|
|
51
|
+
initiate<P extends TransactionsInitiateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"initiate", P, EP>>>;
|
|
52
|
+
/**
|
|
53
|
+
* Initiate a transaction speculatively (dry-run)
|
|
54
|
+
*
|
|
55
|
+
* @template P
|
|
56
|
+
* @template EP
|
|
57
|
+
* @param {P & TransactionsInitiateSpeculativeParameter} params
|
|
58
|
+
* @param {EP} [extraParams]
|
|
59
|
+
* @returns {Promise<AxiosResponse<TransactionsResponse<"initiateSpeculative", P, EP>>>}
|
|
60
|
+
*/
|
|
61
|
+
initiateSpeculative<P extends TransactionsInitiateSpeculativeParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"initiateSpeculative", P, EP>>>;
|
|
62
|
+
/**
|
|
63
|
+
* Transition a transaction to a new state
|
|
64
|
+
*
|
|
65
|
+
* @template P
|
|
66
|
+
* @template EP
|
|
67
|
+
* @param {P & TransactionsTransitionParameter} params
|
|
68
|
+
* @param {EP} [extraParams]
|
|
69
|
+
* @returns {Promise<AxiosResponse<TransactionsResponse<"transition", P, EP>>>}
|
|
70
|
+
*
|
|
71
|
+
* @example
|
|
72
|
+
* await sdk.transactions.transition({
|
|
73
|
+
* id: "tx-abc123",
|
|
74
|
+
* transition: "transition/confirm-payment"
|
|
75
|
+
* });
|
|
76
|
+
*/
|
|
77
|
+
transition<P extends TransactionsTransitionParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"transition", P, EP>>>;
|
|
78
|
+
/**
|
|
79
|
+
* Perform a speculative transition (dry-run)
|
|
80
|
+
*
|
|
81
|
+
* @template P
|
|
82
|
+
* @template EP
|
|
83
|
+
* @param {P & TransactionsTransitionSpeculativeParameter} params
|
|
84
|
+
* @param {EP} [extraParams]
|
|
85
|
+
* @returns {Promise<AxiosResponse<TransactionsResponse<"transitionSpeculative", P, EP>>>}
|
|
86
|
+
*/
|
|
87
|
+
transitionSpeculative<P extends TransactionsTransitionSpeculativeParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"transitionSpeculative", P, EP>>>;
|
|
88
|
+
}
|
|
89
|
+
export default Transactions;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for fetching public user profiles in the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* Use this to retrieve publicly visible information about any user (e.g. name, bio, profile image).
|
|
5
|
+
* Only returns data the current user is allowed to see.
|
|
6
|
+
*
|
|
7
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#show-user
|
|
8
|
+
*/
|
|
9
|
+
import type { AxiosResponse } from "axios";
|
|
10
|
+
import MarketplaceApi from "./index";
|
|
11
|
+
import { UsersResponse, UsersShowParameter } from "../../types";
|
|
12
|
+
/**
|
|
13
|
+
* Public Users API client
|
|
14
|
+
*/
|
|
15
|
+
declare class Users {
|
|
16
|
+
private readonly axios;
|
|
17
|
+
private readonly endpoint;
|
|
18
|
+
private readonly headers;
|
|
19
|
+
constructor(api: MarketplaceApi);
|
|
20
|
+
/**
|
|
21
|
+
* Fetch a public user profile by ID
|
|
22
|
+
*
|
|
23
|
+
* @template P
|
|
24
|
+
* @param {P & UsersShowParameter} params
|
|
25
|
+
* @returns {Promise<AxiosResponse<UsersResponse<"show", P>>>}
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* const { data } = await sdk.users.show({ id: "user-abc123" });
|
|
29
|
+
* console.log(data.attributes.profile.displayName);
|
|
30
|
+
* console.log(data.attributes.profile.bio);
|
|
31
|
+
*/
|
|
32
|
+
show<P extends UsersShowParameter>(params: P): Promise<AxiosResponse<UsersResponse<"show", P>>>;
|
|
33
|
+
}
|
|
34
|
+
export default Users;
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Client for the Sharetribe Marketplace API.
|
|
3
|
+
*
|
|
4
|
+
* This is the main entry point for client-side applications.
|
|
5
|
+
* Provides access to all public and authenticated endpoints:
|
|
6
|
+
* - Listings, bookings, messages, reviews
|
|
7
|
+
* - Current user management (signup, profile, password)
|
|
8
|
+
* - Image uploads, Stripe payments
|
|
9
|
+
* - Availability & stock queries
|
|
10
|
+
*
|
|
11
|
+
* Use `sdk.marketplace` for all frontend or authenticated user flows.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* const sdk = new SharetribeSdk({ clientId: "abc123" });
|
|
15
|
+
*
|
|
16
|
+
* // Fetch current user
|
|
17
|
+
* const { data: user } = await sdk.marketplace.currentUser.show();
|
|
18
|
+
*
|
|
19
|
+
* // Query public listings
|
|
20
|
+
* const { data: listings } = await sdk.marketplace.listings.query({ perPage: 20 });
|
|
21
|
+
*/
|
|
22
|
+
import type { AxiosInstance } from "axios";
|
|
23
|
+
import SharetribeSdk from "../../sdk";
|
|
24
|
+
import AvailabilityExceptions from "./AvailabilityExceptions";
|
|
25
|
+
import Bookings from "./Bookings";
|
|
26
|
+
import CurrentUser from "./CurrentUser";
|
|
27
|
+
import Images from "./Images";
|
|
28
|
+
import Listings from "./Listings";
|
|
29
|
+
import Marketplace from "./Marketplace";
|
|
30
|
+
import Messages from "./Messages";
|
|
31
|
+
import OwnListings from "./OwnListings";
|
|
32
|
+
import PasswordReset from "./PasswordReset";
|
|
33
|
+
import ProcessTransitions from "./ProcessTransitions";
|
|
34
|
+
import Reviews from "./Reviews";
|
|
35
|
+
import Stock from "./Stock";
|
|
36
|
+
import StockAdjustments from "./StockAdjustments";
|
|
37
|
+
import StripeAccount from "./StripeAccount";
|
|
38
|
+
import StripeAccountLinks from "./StripeAccountLinks";
|
|
39
|
+
import StripeCustomer from "./StripeCustomer";
|
|
40
|
+
import StripePersons from "./StripePersons";
|
|
41
|
+
import StripeSetupIntents from "./StripeSetupIntents";
|
|
42
|
+
import TimeSlots from "./TimeSlots";
|
|
43
|
+
import Transactions from "./Transactions";
|
|
44
|
+
import Users from "./Users";
|
|
45
|
+
/**
|
|
46
|
+
* Marketplace API client
|
|
47
|
+
*/
|
|
48
|
+
declare class MarketplaceApi {
|
|
49
|
+
/** Axios instance with auth & base config */
|
|
50
|
+
readonly axios: AxiosInstance;
|
|
51
|
+
/** Base URL for all Marketplace API endpoints */
|
|
52
|
+
readonly endpoint: string;
|
|
53
|
+
/** Default headers (includes Authorization when logged in) */
|
|
54
|
+
readonly headers: Record<string, string>;
|
|
55
|
+
/** Most endpoints require authentication */
|
|
56
|
+
readonly authRequired = true;
|
|
57
|
+
readonly availabilityExceptions: AvailabilityExceptions;
|
|
58
|
+
readonly bookings: Bookings;
|
|
59
|
+
readonly currentUser: CurrentUser;
|
|
60
|
+
readonly images: Images;
|
|
61
|
+
readonly listings: Listings;
|
|
62
|
+
readonly marketplace: Marketplace;
|
|
63
|
+
readonly messages: Messages;
|
|
64
|
+
readonly ownListings: OwnListings;
|
|
65
|
+
readonly passwordReset: PasswordReset;
|
|
66
|
+
readonly processTransitions: ProcessTransitions;
|
|
67
|
+
readonly reviews: Reviews;
|
|
68
|
+
readonly stock: Stock;
|
|
69
|
+
readonly stockAdjustments: StockAdjustments;
|
|
70
|
+
readonly stripeAccount: StripeAccount;
|
|
71
|
+
readonly stripeAccountLinks: StripeAccountLinks;
|
|
72
|
+
readonly stripeCustomer: StripeCustomer;
|
|
73
|
+
readonly stripePersons: StripePersons;
|
|
74
|
+
readonly stripeSetupIntents: StripeSetupIntents;
|
|
75
|
+
readonly timeslots: TimeSlots;
|
|
76
|
+
readonly transactions: Transactions;
|
|
77
|
+
readonly users: Users;
|
|
78
|
+
constructor(sdk: SharetribeSdk);
|
|
79
|
+
}
|
|
80
|
+
export default MarketplaceApi;
|