@vansite/ts-sharetribe-flex-sdk 1.0.34 → 3.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/SitemapData.d.ts +60 -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 +82 -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} +35 -5
- 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} +35 -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} +35 -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 +35 -0
- package/dist/sdkTypes/UUID.d.ts +45 -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/SitemapData.d.ts +61 -0
- package/dist/types/endpoints/marketplace/SitemapData.d.ts.map +1 -0
- 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 +52 -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/sitemapData.d.ts +47 -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 +9 -2
- package/dist/types/sdkTypes/Money.d.ts.map +1 -1
- package/dist/types/sdkTypes/UUID.d.ts +8 -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/sitemapData.d.ts +48 -0
- package/dist/types/types/marketplace/sitemapData.d.ts.map +1 -0
- 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/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 +17 -4
- package/dist/types/utils/stores/BrowserStore.d.ts.map +1 -1
- package/dist/types/utils/stores/ExpressStore.d.ts +26 -8
- 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/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 +51 -0
- package/dist/utils/stores/ExpressStore.d.ts +67 -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 +16 -14
- 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
|
@@ -1,23 +1,38 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @fileoverview
|
|
3
|
-
* This class serves as the entry point for interacting with various resources such as listings, bookings, users, and payments.
|
|
2
|
+
* @fileoverview Client for the Sharetribe Marketplace API.
|
|
4
3
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
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 });
|
|
7
21
|
*/
|
|
22
|
+
import type { AxiosInstance } from "axios";
|
|
8
23
|
import SharetribeSdk from "../../sdk";
|
|
9
|
-
import { AxiosInstance } from "axios";
|
|
10
24
|
import AvailabilityExceptions from "./AvailabilityExceptions";
|
|
11
|
-
import Listings from "./Listings";
|
|
12
25
|
import Bookings from "./Bookings";
|
|
13
26
|
import CurrentUser from "./CurrentUser";
|
|
14
27
|
import Images from "./Images";
|
|
28
|
+
import Listings from "./Listings";
|
|
15
29
|
import Marketplace from "./Marketplace";
|
|
16
30
|
import Messages from "./Messages";
|
|
17
31
|
import OwnListings from "./OwnListings";
|
|
18
32
|
import PasswordReset from "./PasswordReset";
|
|
19
33
|
import ProcessTransitions from "./ProcessTransitions";
|
|
20
34
|
import Reviews from "./Reviews";
|
|
35
|
+
import SitemapData from "./SitemapData";
|
|
21
36
|
import Stock from "./Stock";
|
|
22
37
|
import StockAdjustments from "./StockAdjustments";
|
|
23
38
|
import StripeAccount from "./StripeAccount";
|
|
@@ -29,42 +44,39 @@ import TimeSlots from "./TimeSlots";
|
|
|
29
44
|
import Transactions from "./Transactions";
|
|
30
45
|
import Users from "./Users";
|
|
31
46
|
/**
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* This class provides access to all available endpoints in the Sharetribe Marketplace API, enabling operations such as managing listings,
|
|
35
|
-
* handling transactions, updating user profiles, and integrating with Stripe.
|
|
47
|
+
* Marketplace API client
|
|
36
48
|
*/
|
|
37
49
|
declare class MarketplaceApi {
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
50
|
+
/** Axios instance with auth & base config */
|
|
51
|
+
readonly axios: AxiosInstance;
|
|
52
|
+
/** Base URL for all Marketplace API endpoints */
|
|
53
|
+
readonly endpoint: string;
|
|
54
|
+
/** Default headers (includes Authorization when logged in) */
|
|
55
|
+
readonly headers: Record<string, string>;
|
|
56
|
+
/** Most endpoints require authentication */
|
|
57
|
+
readonly authRequired = true;
|
|
58
|
+
readonly availabilityExceptions: AvailabilityExceptions;
|
|
59
|
+
readonly bookings: Bookings;
|
|
60
|
+
readonly currentUser: CurrentUser;
|
|
61
|
+
readonly images: Images;
|
|
62
|
+
readonly listings: Listings;
|
|
63
|
+
readonly marketplace: Marketplace;
|
|
64
|
+
readonly messages: Messages;
|
|
65
|
+
readonly ownListings: OwnListings;
|
|
66
|
+
readonly passwordReset: PasswordReset;
|
|
67
|
+
readonly processTransitions: ProcessTransitions;
|
|
68
|
+
readonly reviews: Reviews;
|
|
69
|
+
readonly sitemapData: SitemapData;
|
|
70
|
+
readonly stock: Stock;
|
|
71
|
+
readonly stockAdjustments: StockAdjustments;
|
|
72
|
+
readonly stripeAccount: StripeAccount;
|
|
73
|
+
readonly stripeAccountLinks: StripeAccountLinks;
|
|
74
|
+
readonly stripeCustomer: StripeCustomer;
|
|
75
|
+
readonly stripePersons: StripePersons;
|
|
76
|
+
readonly stripeSetupIntents: StripeSetupIntents;
|
|
77
|
+
readonly timeslots: TimeSlots;
|
|
78
|
+
readonly transactions: Transactions;
|
|
79
|
+
readonly users: Users;
|
|
68
80
|
constructor(sdk: SharetribeSdk);
|
|
69
81
|
}
|
|
70
82
|
export default MarketplaceApi;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,OAAO,CAAC;AACzC,OAAO,aAAa,MAAM,WAAW,CAAC;AAEtC,OAAO,sBAAsB,MAAM,0BAA0B,CAAC;AAC9D,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,WAAW,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,gBAAgB,MAAM,oBAAoB,CAAC;AAClD,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AACtD,OAAO,SAAS,MAAM,aAAa,CAAC;AACpC,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,SAAS,CAAC;AAE5B;;GAEG;AACH,cAAM,cAAc;IAClB,6CAA6C;IAC7C,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAE9B,iDAAiD;IACjD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC,4CAA4C;IAC5C,QAAQ,CAAC,YAAY,QAAQ;IAG7B,QAAQ,CAAC,sBAAsB,EAAE,sBAAsB,CAAC;IACxD,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IAC5C,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IACxC,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;gBAEV,GAAG,EAAE,aAAa;CA+B/B;AAED,eAAe,cAAc,CAAC"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -16,10 +16,12 @@ import BrowserStore from "./utils/stores/BrowserStore";
|
|
|
16
16
|
import ExpressStore from "./utils/stores/ExpressStore";
|
|
17
17
|
import { objectQueryString } from "./utils/util";
|
|
18
18
|
import { read, write } from "./utils/transit";
|
|
19
|
+
import { generateKey } from "./utils/stores/store";
|
|
19
20
|
export * from "./types/assets";
|
|
20
21
|
export * from "./types/authentication";
|
|
21
22
|
export * from "./types/integration/events";
|
|
22
23
|
export * from "./types/marketplace/availabilityExceptions";
|
|
24
|
+
export * from "./types/marketplace/availabilityPlan";
|
|
23
25
|
export * from "./types/marketplace/bookings";
|
|
24
26
|
export * from "./types/marketplace/currentUser";
|
|
25
27
|
export * from "./types/marketplace/images";
|
|
@@ -75,33 +77,23 @@ export type SdkTypes = {
|
|
|
75
77
|
replacer: typeof replacer;
|
|
76
78
|
reviver: typeof reviver;
|
|
77
79
|
};
|
|
78
|
-
|
|
79
|
-
* Token store implementations for managing authentication tokens.
|
|
80
|
-
*/
|
|
81
|
-
export declare const TokenStore: {
|
|
82
|
-
/** In-memory token store for temporary token management. */
|
|
83
|
-
MemoryStore: typeof MemoryStore;
|
|
84
|
-
/** Browser token store using cookies. */
|
|
85
|
-
BrowserStore: typeof BrowserStore;
|
|
86
|
-
/** Express.js-compatible token store using request and response cookies. */
|
|
87
|
-
ExpressStore: typeof ExpressStore;
|
|
88
|
-
};
|
|
89
|
-
export type TokenStore = {
|
|
80
|
+
export type TokenStores = {
|
|
90
81
|
MemoryStore: typeof MemoryStore;
|
|
91
82
|
BrowserStore: typeof BrowserStore;
|
|
92
83
|
ExpressStore: typeof ExpressStore;
|
|
93
84
|
};
|
|
94
85
|
/**
|
|
95
|
-
*
|
|
86
|
+
* Token store implementations for managing authentication tokens.
|
|
96
87
|
*/
|
|
97
|
-
export declare const
|
|
98
|
-
read: (str: string, opts?: import("./utils/transit").TransitOptions) => any;
|
|
99
|
-
write: (data: any, opts?: import("./utils/transit").TransitOptions) => string;
|
|
100
|
-
};
|
|
88
|
+
export declare const TokenStores: TokenStores;
|
|
101
89
|
export type Transit = {
|
|
102
90
|
read: typeof read;
|
|
103
91
|
write: typeof write;
|
|
104
92
|
};
|
|
93
|
+
/**
|
|
94
|
+
* Transit utilities for reading and writing transit data.
|
|
95
|
+
*/
|
|
96
|
+
export declare const transit: Transit;
|
|
105
97
|
/**
|
|
106
98
|
* Export the Sharetribe SDK and Integration SDK.
|
|
107
99
|
*/
|
|
@@ -117,9 +109,11 @@ export declare const util: {
|
|
|
117
109
|
objectQueryString: (obj: {
|
|
118
110
|
[x: string]: any;
|
|
119
111
|
}) => string;
|
|
112
|
+
generateKey: (clientId: string, namespace: string) => string;
|
|
120
113
|
};
|
|
121
114
|
export type Util = {
|
|
122
115
|
objectQueryString: typeof objectQueryString;
|
|
116
|
+
generateKey: typeof generateKey;
|
|
123
117
|
};
|
|
124
118
|
declare const defaultExport: {
|
|
125
119
|
/** Export of the Sharetribe SDK. */
|
|
@@ -127,14 +121,7 @@ declare const defaultExport: {
|
|
|
127
121
|
/** Export of the Integration SDK. */
|
|
128
122
|
SharetribeIntegrationSdk: typeof IntegrationSdkExport;
|
|
129
123
|
/** Export of available token stores. */
|
|
130
|
-
|
|
131
|
-
/** In-memory token store for temporary token management. */
|
|
132
|
-
MemoryStore: typeof MemoryStore;
|
|
133
|
-
/** Browser token store using cookies. */
|
|
134
|
-
BrowserStore: typeof BrowserStore;
|
|
135
|
-
/** Express.js-compatible token store using request and response cookies. */
|
|
136
|
-
ExpressStore: typeof ExpressStore;
|
|
137
|
-
};
|
|
124
|
+
TokenStores: TokenStores;
|
|
138
125
|
/** Export of SDK-specific types. */
|
|
139
126
|
sdkTypes: {
|
|
140
127
|
/** A representation of a high-precision decimal number. */
|
|
@@ -158,18 +145,16 @@ declare const defaultExport: {
|
|
|
158
145
|
objectQueryString: (obj: {
|
|
159
146
|
[x: string]: any;
|
|
160
147
|
}) => string;
|
|
148
|
+
generateKey: (clientId: string, namespace: string) => string;
|
|
161
149
|
};
|
|
162
150
|
/** Export of Transit utilities. */
|
|
163
|
-
transit:
|
|
164
|
-
read: (str: string, opts?: import("./utils/transit").TransitOptions) => any;
|
|
165
|
-
write: (data: any, opts?: import("./utils/transit").TransitOptions) => string;
|
|
166
|
-
};
|
|
151
|
+
transit: Transit;
|
|
167
152
|
};
|
|
168
153
|
export default defaultExport;
|
|
169
154
|
export type DefaultExport = {
|
|
170
155
|
SharetribeSdk: SharetribeSdkExport;
|
|
171
156
|
SharetribeIntegrationSdk: IntegrationSdkExport;
|
|
172
|
-
|
|
157
|
+
TokenStores: typeof TokenStores;
|
|
173
158
|
sdkTypes: typeof sdkTypes;
|
|
174
159
|
util: typeof util;
|
|
175
160
|
transit: typeof transit;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,mBAAmB,MAAM,OAAO,CAAC;AACxC,OAAO,oBAAoB,MAAM,kBAAkB,CAAC;AACpD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,IAAI,MAAM,iBAAiB,CAAC;AACnC,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,YAAY,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,MAAM,kBAAkB,CAAC;AACrC,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,mBAAmB,MAAM,OAAO,CAAC;AACxC,OAAO,oBAAoB,MAAM,kBAAkB,CAAC;AACpD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,IAAI,MAAM,iBAAiB,CAAC;AACnC,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,YAAY,MAAM,yBAAyB,CAAC;AACnD,OAAO,KAAK,MAAM,kBAAkB,CAAC;AACrC,OAAO,EAAC,QAAQ,EAAE,OAAO,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,WAAW,MAAM,4BAA4B,CAAC;AACrD,OAAO,YAAY,MAAM,6BAA6B,CAAC;AACvD,OAAO,YAAY,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAC,IAAI,EAAE,KAAK,EAAC,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AAGjD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAChD,cAAc,mCAAmC,CAAC;AAClD,cAAc,wCAAwC,CAAC;AACvD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,mCAAmC,CAAC;AAClD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,yCAAyC,CAAC;AACxD,cAAc,mCAAmC,CAAC;AAClD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,QAAQ;IACnB,2DAA2D;;IAE3D,wDAAwD;;IAExD,6EAA6E;;IAE7E,oDAAoD;;IAEpD,8CAA8C;;IAE9C,gDAAgD;;IAEhD,iDAAiD;;CAElD,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,UAAU,EAAE,OAAO,UAAU,CAAC;IAC9B,MAAM,EAAE,OAAO,MAAM,CAAC;IACtB,YAAY,EAAE,OAAO,YAAY,CAAC;IAClC,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,IAAI,EAAE,OAAO,IAAI,CAAC;IAClB,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1B,OAAO,EAAE,OAAO,OAAO,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,OAAO,WAAW,CAAC;IAChC,YAAY,EAAE,OAAO,YAAY,CAAC;IAClC,YAAY,EAAE,OAAO,YAAY,CAAC;CACnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,WAOzB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,OAAO,IAAI,CAAC;IAClB,KAAK,EAAE,OAAO,KAAK,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,OAGrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,4BAAsB,CAAC;AACjD,MAAM,MAAM,aAAa,GAAG,mBAAmB,CAAC;AAEhD,eAAO,MAAM,cAAc,6BAAuB,CAAC;AACnD,MAAM,MAAM,cAAc,GAAG,oBAAoB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,IAAI;IACf,8DAA8D;;;;;CAG/D,CAAC;AACF,MAAM,MAAM,IAAI,GAAG;IACjB,iBAAiB,EAAE,OAAO,iBAAiB,CAAC;IAC5C,WAAW,EAAE,OAAO,WAAW,CAAC;CACjC,CAAC;AAEF,QAAA,MAAM,aAAa;IACjB,oCAAoC;;IAEpC,qCAAqC;;IAErC,wCAAwC;;IAExC,oCAAoC;;QAtFpC,2DAA2D;;QAE3D,wDAAwD;;QAExD,6EAA6E;;QAE7E,oDAAoD;;QAEpD,8CAA8C;;QAE9C,gDAAgD;;QAEhD,iDAAiD;;;IA4EjD,mCAAmC;;QAlBnC,8DAA8D;;;;;;IAoB9D,mCAAmC;;CAEpC,CAAC;AACF,eAAe,aAAa,CAAC;AAE7B,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,EAAE,mBAAmB,CAAC;IACnC,wBAAwB,EAAE,oBAAoB,CAAC;IAC/C,WAAW,EAAE,OAAO,WAAW,CAAC;IAChC,QAAQ,EAAE,OAAO,QAAQ,CAAC;IAC1B,IAAI,EAAE,OAAO,IAAI,CAAC;IAClB,OAAO,EAAE,OAAO,OAAO,CAAC;CACzB,CAAC"}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Type definitions for Events in the Sharetribe Marketplace API.
|
|
3
|
+
*/
|
|
4
|
+
import { ApiMeta, UUID } from "../sharetribe";
|
|
5
|
+
import { ListingWithRelationships } from "../marketplace/listings";
|
|
6
|
+
import { UserWithRelationships } from "../marketplace/user";
|
|
7
|
+
import { AvailabilityExceptionWithRelationships } from "../marketplace/availabilityExceptions";
|
|
8
|
+
import { MessageWithRelationships } from "../marketplace/messages";
|
|
9
|
+
import { TransactionWithRelationships } from "../marketplace/transactions";
|
|
10
|
+
import { BookingWithRelationships } from "../marketplace/bookings";
|
|
11
|
+
import { ReviewWithRelationships } from "../marketplace/reviews";
|
|
12
|
+
import { StockAdjustmentWithRelationships } from "../marketplace/stockAdjustment";
|
|
13
|
+
import { StockReservationWithRelationships } from "../marketplace/stockReservations";
|
|
14
|
+
/**
|
|
15
|
+
* Available endpoints
|
|
16
|
+
*/
|
|
17
|
+
export type EventsEndpoints = "query";
|
|
18
|
+
/**
|
|
19
|
+
* All possible event types
|
|
20
|
+
*/
|
|
21
|
+
export type EventType = "listing/created" | "listing/updated" | "listing/deleted" | "user/created" | "user/updated" | "user/deleted" | "availabilityException/created" | "availabilityException/updated" | "availabilityException/deleted" | "message/created" | "message/updated" | "message/deleted" | "transaction/initiated" | "transaction/transitioned" | "transaction/updated" | "transaction/deleted" | "booking/created" | "booking/updated" | "booking/deleted" | "review/created" | "review/updated" | "review/deleted" | "stockAdjustment/created" | "stockAdjustment/updated" | "stockAdjustment/deleted" | "stockReservation/created" | "stockReservation/updated" | "stockReservation/deleted";
|
|
22
|
+
/**
|
|
23
|
+
* Source of the event
|
|
24
|
+
*/
|
|
25
|
+
export type EventSource = "source/marketplace-api" | "source/integration-api" | "source/transaction" | "source/console" | "source/admin";
|
|
26
|
+
/**
|
|
27
|
+
* Resource types
|
|
28
|
+
*/
|
|
29
|
+
export type EventResourceType = "listing" | "user" | "availabilityException" | "message" | "transaction" | "booking" | "review" | "stockAdjustment" | "stockReservation";
|
|
30
|
+
/**
|
|
31
|
+
* Strongly-typed resource mapping per event type
|
|
32
|
+
*/
|
|
33
|
+
export type EventResource<T extends EventResourceType = EventResourceType> = T extends "listing" ? ListingWithRelationships<true> : T extends "user" ? UserWithRelationships<true> : T extends "availabilityException" ? AvailabilityExceptionWithRelationships : T extends "message" ? MessageWithRelationships : T extends "transaction" ? TransactionWithRelationships : T extends "booking" ? BookingWithRelationships : T extends "review" ? ReviewWithRelationships : T extends "stockAdjustment" ? StockAdjustmentWithRelationships : T extends "stockReservation" ? StockReservationWithRelationships : never;
|
|
34
|
+
/**
|
|
35
|
+
* Audit metadata
|
|
36
|
+
*/
|
|
37
|
+
export interface EventAuditData {
|
|
38
|
+
userId?: UUID | null;
|
|
39
|
+
adminId?: UUID | null;
|
|
40
|
+
clientId?: UUID | null;
|
|
41
|
+
requestId?: UUID | null;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Event resource
|
|
45
|
+
*/
|
|
46
|
+
export interface Event {
|
|
47
|
+
id: UUID;
|
|
48
|
+
type: "event";
|
|
49
|
+
attributes: {
|
|
50
|
+
createdAt: Date;
|
|
51
|
+
sequenceId: number;
|
|
52
|
+
marketplaceId: UUID;
|
|
53
|
+
eventType: EventType;
|
|
54
|
+
source: EventSource;
|
|
55
|
+
resourceId: UUID;
|
|
56
|
+
resourceType: EventResourceType;
|
|
57
|
+
resource: EventResource;
|
|
58
|
+
previousValues?: Record<string, unknown> | null;
|
|
59
|
+
auditData?: EventAuditData | null;
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Query parameters
|
|
64
|
+
*/
|
|
65
|
+
export interface EventsQueryParameter {
|
|
66
|
+
startAfterSequenceId?: number;
|
|
67
|
+
createdAtStart?: Date | string;
|
|
68
|
+
resourceId?: UUID | string;
|
|
69
|
+
relatedResourceId?: UUID | string;
|
|
70
|
+
eventTypes?: EventType[];
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Response data
|
|
74
|
+
*/
|
|
75
|
+
type ResponseData<E extends EventsEndpoints> = E extends "query" ? Event[] : never;
|
|
76
|
+
/**
|
|
77
|
+
* Final response type
|
|
78
|
+
*/
|
|
79
|
+
export type EventsResponse<E extends EventsEndpoints = "query"> = {
|
|
80
|
+
data: ResponseData<E>;
|
|
81
|
+
meta: ApiMeta;
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* Convenience alias
|
|
85
|
+
*/
|
|
86
|
+
export type EventsQueryResponse = EventsResponse<"query">;
|
|
87
|
+
export {};
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import { SdkConfig } from "./types
|
|
1
|
+
import { ApiConfigs, SdkConfig } from "./types";
|
|
2
2
|
import { AxiosInstance } from "axios";
|
|
3
|
-
import { ApiConfigs } from "./types/apiConfigs";
|
|
4
3
|
import IntegrationApi from "./endpoints/integrationApi";
|
|
5
4
|
import AuthenticationApi from "./endpoints/auth";
|
|
6
5
|
import AvailabilityExceptions from "./endpoints/integrationApi/AvailabilityExceptions";
|
|
@@ -10,7 +9,7 @@ import Listings from "./endpoints/integrationApi/Listings";
|
|
|
10
9
|
import Marketplace from "./endpoints/integrationApi/Marketplace";
|
|
11
10
|
import Stock from "./endpoints/integrationApi/Stock";
|
|
12
11
|
import StockAdjustments from "./endpoints/integrationApi/StockAdjustments";
|
|
13
|
-
import
|
|
12
|
+
import StockReservations from "./endpoints/integrationApi/StockReservations";
|
|
14
13
|
import Transactions from "./endpoints/integrationApi/Transactions";
|
|
15
14
|
import Users from "./endpoints/integrationApi/Users";
|
|
16
15
|
/**
|
|
@@ -94,9 +93,9 @@ declare class IntegrationSdk {
|
|
|
94
93
|
/**
|
|
95
94
|
* Endpoint for managing stock reservations.
|
|
96
95
|
*
|
|
97
|
-
* @type {
|
|
96
|
+
* @type {StockReservations}
|
|
98
97
|
*/
|
|
99
|
-
stockReservations:
|
|
98
|
+
stockReservations: StockReservations;
|
|
100
99
|
/**
|
|
101
100
|
* Endpoint for managing transactions.
|
|
102
101
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"integrationSdk.d.ts","sourceRoot":"","sources":["../../src/integrationSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,
|
|
1
|
+
{"version":3,"file":"integrationSdk.d.ts","sourceRoot":"","sources":["../../src/integrationSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,SAAS,EAAC,MAAM,SAAS,CAAC;AAC9C,OAAc,EAAC,aAAa,EAAC,MAAM,OAAO,CAAC;AAC3C,OAAO,cAAc,MAAM,4BAA4B,CAAC;AAGxD,OAAO,iBAAiB,MAAM,kBAAkB,CAAC;AACjD,OAAO,sBAAsB,MAAM,mDAAmD,CAAC;AACvF,OAAO,MAAM,MAAM,mCAAmC,CAAC;AACvD,OAAO,MAAM,MAAM,mCAAmC,CAAC;AACvD,OAAO,QAAQ,MAAM,qCAAqC,CAAC;AAC3D,OAAO,WAAW,MAAM,wCAAwC,CAAC;AACjE,OAAO,KAAK,MAAM,kCAAkC,CAAC;AACrD,OAAO,gBAAgB,MAAM,6CAA6C,CAAC;AAC3E,OAAO,iBAAiB,MAAM,8CAA8C,CAAC;AAC7E,OAAO,YAAY,MAAM,yCAAyC,CAAC;AACnE,OAAO,KAAK,MAAM,kCAAkC,CAAC;AAGrD;;;;GAIG;AACH,cAAM,cAAc;IAClB;;;;OAIG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;;;OAIG;IACH,WAAW,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;IAE9B;;;;OAIG;IACH,KAAK,EAAE,aAAa,CAAC;IAGrB;;;;OAIG;IACH,IAAI,EAAE,iBAAiB,CAAC;IAExB;;;;OAIG;IACH,eAAe,EAAE,cAAc,CAAC;IAGhC;;;;OAIG;IACH,sBAAsB,EAAE,sBAAsB,CAAC;IAE/C;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;;;OAIG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;;;OAIG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;;;OAIG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC;;;;OAIG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IAErC;;;;OAIG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;;OAIG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;;;;OAKG;gBACS,MAAM,EAAE,SAAS;CA+B9B;AAED,eAAe,cAAc,CAAC"}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Type definitions for Availability Exceptions in the Sharetribe Marketplace API.
|
|
3
|
+
*/
|
|
4
|
+
import { ApiMeta, ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
|
|
5
|
+
/**
|
|
6
|
+
* Available endpoints
|
|
7
|
+
*/
|
|
8
|
+
export type AvailabilityExceptionsEndpoints = "query" | "create" | "delete";
|
|
9
|
+
/**
|
|
10
|
+
* Relationship fields that can be included
|
|
11
|
+
*/
|
|
12
|
+
export type AvailabilityExceptionsRelationshipsFields = "ownListing" | "ownListing.marketplace" | "ownListing.author" | "ownListing.images" | "ownListing.currentStock";
|
|
13
|
+
/**
|
|
14
|
+
* Availability Exception resource
|
|
15
|
+
*/
|
|
16
|
+
export interface AvailabilityException {
|
|
17
|
+
id: UUID;
|
|
18
|
+
type: "availabilityException";
|
|
19
|
+
attributes: {
|
|
20
|
+
seats: number;
|
|
21
|
+
start: Date;
|
|
22
|
+
end: Date;
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* With relationships
|
|
27
|
+
*/
|
|
28
|
+
export interface AvailabilityExceptionWithRelationships extends AvailabilityException {
|
|
29
|
+
relationships: {
|
|
30
|
+
ownListing: Relationship<false, "ownListing">;
|
|
31
|
+
};
|
|
32
|
+
}
|
|
33
|
+
export type AvailabilityExceptionResource<R extends boolean> = R extends true ? AvailabilityExceptionWithRelationships : AvailabilityException;
|
|
34
|
+
/**
|
|
35
|
+
* Base request parameters
|
|
36
|
+
*/
|
|
37
|
+
export interface AvailabilityExceptionsParameter extends ApiParameter {
|
|
38
|
+
include?: AvailabilityExceptionsRelationshipsFields[];
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Query endpoint
|
|
42
|
+
*/
|
|
43
|
+
export interface AvailabilityExceptionsQueryParameter extends AvailabilityExceptionsParameter {
|
|
44
|
+
listingId: UUID | string;
|
|
45
|
+
start: Date | string;
|
|
46
|
+
end: Date | string;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Create endpoint
|
|
50
|
+
*/
|
|
51
|
+
export interface AvailabilityExceptionsCreateParameter extends AvailabilityExceptionsParameter {
|
|
52
|
+
listingId: UUID | string;
|
|
53
|
+
seats: number;
|
|
54
|
+
start: Date | string;
|
|
55
|
+
end: Date | string;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Delete endpoint
|
|
59
|
+
*/
|
|
60
|
+
export type AvailabilityExceptionsDeleteParameter = {
|
|
61
|
+
id: UUID | string;
|
|
62
|
+
};
|
|
63
|
+
/**
|
|
64
|
+
* All parameter types
|
|
65
|
+
*/
|
|
66
|
+
type AllAvailabilityExceptionsParameter = AvailabilityExceptionsQueryParameter | AvailabilityExceptionsCreateParameter | AvailabilityExceptionsDeleteParameter;
|
|
67
|
+
/**
|
|
68
|
+
* Include detection — fixes TS2536
|
|
69
|
+
*/
|
|
70
|
+
type HasInclude<P> = P extends {
|
|
71
|
+
include: infer I extends readonly AvailabilityExceptionsRelationshipsFields[];
|
|
72
|
+
} ? I : never;
|
|
73
|
+
type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
|
|
74
|
+
type IncludedResources<P> = P extends {
|
|
75
|
+
include: infer I extends readonly AvailabilityExceptionsRelationshipsFields[];
|
|
76
|
+
} ? RelationshipTypeMap[I[number]][] : never;
|
|
77
|
+
/**
|
|
78
|
+
* Expand behavior
|
|
79
|
+
*/
|
|
80
|
+
type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
|
|
81
|
+
expand: true;
|
|
82
|
+
} ? T : EP extends {
|
|
83
|
+
expand: false;
|
|
84
|
+
} ? Omit<T, "attributes"> : Omit<T, "attributes">;
|
|
85
|
+
/**
|
|
86
|
+
* Response data per endpoint
|
|
87
|
+
*/
|
|
88
|
+
type ResponseData<E extends AvailabilityExceptionsEndpoints, P extends AllAvailabilityExceptionsParameter, EP extends ExtraParameterType | undefined> = E extends "query" ? AvailabilityExceptionResource<IncludesRelationships<P>>[] : E extends "create" ? ExpandResult<AvailabilityExceptionResource<IncludesRelationships<P>>, EP> : E extends "delete" ? Pick<AvailabilityException, "id" | "type"> : never;
|
|
89
|
+
/**
|
|
90
|
+
* Final response type
|
|
91
|
+
*/
|
|
92
|
+
export type AvailabilityExceptionsResponse<E extends AvailabilityExceptionsEndpoints, P extends AllAvailabilityExceptionsParameter, EP extends ExtraParameterType | undefined = undefined> = {
|
|
93
|
+
data: ResponseData<E, P, EP>;
|
|
94
|
+
} & (IncludesRelationships<P> extends true ? {
|
|
95
|
+
included: IncludedResources<P>;
|
|
96
|
+
} : {}) & (E extends "query" ? {
|
|
97
|
+
meta: ApiMeta;
|
|
98
|
+
} : {});
|
|
99
|
+
export {};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Availability plan types
|
|
3
|
+
*/
|
|
4
|
+
type AvailabilityPlanType = "availability-plan/day" | "availability-plan/time";
|
|
5
|
+
type AvailabilityPlanEntry<T extends AvailabilityPlanType = AvailabilityPlanType> = {
|
|
6
|
+
dayOfWeek: "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";
|
|
7
|
+
seats: number;
|
|
8
|
+
} & (T extends "availability-plan/time" ? {
|
|
9
|
+
startTime: string;
|
|
10
|
+
endTime: string;
|
|
11
|
+
} : {});
|
|
12
|
+
export type AvailabilityPlan<T extends AvailabilityPlanType = "availability-plan/day"> = {
|
|
13
|
+
type: T;
|
|
14
|
+
timezone: string;
|
|
15
|
+
entries: Array<AvailabilityPlanEntry<T>>;
|
|
16
|
+
};
|
|
17
|
+
export {};
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview Type definitions for Bookings in the Sharetribe Marketplace API.
|
|
3
|
+
*/
|
|
4
|
+
import { ApiMeta, ApiParameter, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
|
|
5
|
+
/**
|
|
6
|
+
* Available endpoints
|
|
7
|
+
*/
|
|
8
|
+
export type BookingsEndpoints = "query";
|
|
9
|
+
/**
|
|
10
|
+
* Relationship fields that can be included
|
|
11
|
+
*/
|
|
12
|
+
export type BookingsRelationshipsFields = "transaction" | "transaction.marketplace" | "transaction.listing" | "transaction.provider" | "transaction.customer" | "transaction.booking" | "transaction.stockReservation" | "transaction.reviews" | "transaction.messages";
|
|
13
|
+
/**
|
|
14
|
+
* Booking states
|
|
15
|
+
*/
|
|
16
|
+
export type BookingState = "pending" | "proposed" | "accepted" | "declined" | "cancelled";
|
|
17
|
+
/**
|
|
18
|
+
* Booking resource
|
|
19
|
+
*/
|
|
20
|
+
export interface Booking {
|
|
21
|
+
id: UUID;
|
|
22
|
+
type: "booking";
|
|
23
|
+
attributes: {
|
|
24
|
+
seats: number;
|
|
25
|
+
start: Date;
|
|
26
|
+
end: Date;
|
|
27
|
+
displayStart: Date;
|
|
28
|
+
displayEnd: Date;
|
|
29
|
+
state: BookingState;
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* With relationships
|
|
34
|
+
*/
|
|
35
|
+
export interface BookingWithRelationships extends Booking {
|
|
36
|
+
relationships: {
|
|
37
|
+
transaction: Relationship<false, "transaction">;
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
export type BookingResource<R extends boolean> = R extends true ? BookingWithRelationships : Booking;
|
|
41
|
+
/**
|
|
42
|
+
* Base request parameters
|
|
43
|
+
*/
|
|
44
|
+
export interface BookingsParameter extends ApiParameter {
|
|
45
|
+
include?: BookingsRelationshipsFields[];
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Query parameters
|
|
49
|
+
*/
|
|
50
|
+
export interface BookingsQueryParameter extends BookingsParameter {
|
|
51
|
+
listingId: UUID | string;
|
|
52
|
+
start: Date | string;
|
|
53
|
+
end: Date | string;
|
|
54
|
+
state?: BookingState;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Include detection — fixes TS2536
|
|
58
|
+
*/
|
|
59
|
+
type HasInclude<P> = P extends {
|
|
60
|
+
include: infer I extends readonly BookingsRelationshipsFields[];
|
|
61
|
+
} ? I : never;
|
|
62
|
+
type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
|
|
63
|
+
type IncludedResources<P> = P extends {
|
|
64
|
+
include: infer Fields extends readonly BookingsRelationshipsFields[];
|
|
65
|
+
} ? RelationshipTypeMap[Fields[number]][] : never;
|
|
66
|
+
/**
|
|
67
|
+
* Response data
|
|
68
|
+
*/
|
|
69
|
+
type ResponseData<E extends BookingsEndpoints, P extends BookingsQueryParameter> = E extends "query" ? BookingResource<IncludesRelationships<P>>[] : never;
|
|
70
|
+
/**
|
|
71
|
+
* Final response type
|
|
72
|
+
*/
|
|
73
|
+
export type BookingsResponse<E extends BookingsEndpoints = "query", P extends BookingsQueryParameter = BookingsQueryParameter> = {
|
|
74
|
+
data: ResponseData<E, P>;
|
|
75
|
+
} & (IncludesRelationships<P> extends true ? {
|
|
76
|
+
included: IncludedResources<P>;
|
|
77
|
+
} : {}) & {
|
|
78
|
+
meta: ApiMeta;
|
|
79
|
+
};
|
|
80
|
+
export {};
|