@vansite/ts-sharetribe-flex-sdk 1.0.34 → 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} +13 -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} +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/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/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 +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,36 +1,32 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @fileoverview
|
|
3
|
-
* This class allows accessing configuration and metadata about the marketplace.
|
|
2
|
+
* @fileoverview Client for fetching marketplace configuration in the Sharetribe Marketplace API.
|
|
4
3
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* Use this to get metadata about your marketplace — name, description, currency, logo,
|
|
5
|
+
* supported countries, payout settings, and more.
|
|
6
|
+
*
|
|
7
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#marketplace
|
|
7
8
|
*/
|
|
8
|
-
import { AxiosResponse } from "axios";
|
|
9
|
+
import type { AxiosResponse } from "axios";
|
|
9
10
|
import MarketplaceApi from "./index";
|
|
10
|
-
import { MarketplaceResponse } from "../../types
|
|
11
|
+
import { MarketplaceResponse } from "../../types";
|
|
11
12
|
/**
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* The Marketplace API provides methods to retrieve configuration and metadata about the marketplace.
|
|
13
|
+
* Public Marketplace API client
|
|
15
14
|
*/
|
|
16
15
|
declare class Marketplace {
|
|
17
|
-
private readonly endpoint;
|
|
18
16
|
private readonly axios;
|
|
17
|
+
private readonly endpoint;
|
|
19
18
|
private readonly headers;
|
|
20
|
-
/**
|
|
21
|
-
* Creates an instance of the Marketplace class.
|
|
22
|
-
*
|
|
23
|
-
* @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
|
|
24
|
-
*/
|
|
25
19
|
constructor(api: MarketplaceApi);
|
|
26
20
|
/**
|
|
27
|
-
*
|
|
21
|
+
* Fetch current marketplace configuration
|
|
28
22
|
*
|
|
29
|
-
* @returns {Promise<AxiosResponse<MarketplaceResponse<
|
|
23
|
+
* @returns {Promise<AxiosResponse<MarketplaceResponse<"show">>>}
|
|
30
24
|
*
|
|
31
25
|
* @example
|
|
32
|
-
* const
|
|
33
|
-
*
|
|
26
|
+
* const { data } = await sdk.marketplace.show();
|
|
27
|
+
* console.log(data.attributes.name); // → "My Awesome Marketplace"
|
|
28
|
+
* console.log(data.attributes.currency); // → "USD"
|
|
29
|
+
* console.log(data.attributes.country); // → "FI"
|
|
34
30
|
*/
|
|
35
31
|
show(): Promise<AxiosResponse<MarketplaceResponse<"show">>>;
|
|
36
32
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Marketplace.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Marketplace.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"Marketplace.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Marketplace.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EAAC,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAEhD;;GAEG;AACH,cAAM,WAAW;IACf,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;OAUG;IACG,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;CAKlE;AAED,eAAe,WAAW,CAAC"}
|
|
@@ -1,57 +1,52 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @fileoverview
|
|
3
|
-
* This class allows querying and sending messages.
|
|
2
|
+
* @fileoverview Client for querying and sending messages in the Sharetribe Marketplace API.
|
|
4
3
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* Use this to read conversation history and send messages in transactions.
|
|
5
|
+
* Messages are tied to a specific transaction (order/inquiry).
|
|
6
|
+
*
|
|
7
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#messages
|
|
7
8
|
*/
|
|
8
|
-
import { AxiosResponse } from "axios";
|
|
9
|
+
import type { AxiosResponse } from "axios";
|
|
9
10
|
import MarketplaceApi from "./index";
|
|
10
|
-
import { ExtraParameter } from "../../types
|
|
11
|
-
import { MessagesQueryParameter, MessagesResponse, MessagesSendParameter } from "../../types/marketplace/messages";
|
|
11
|
+
import { ExtraParameter, MessagesQueryParameter, MessagesResponse, MessagesSendParameter } from "../../types";
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* The Messages API provides methods to query and send messages in the marketplace.
|
|
13
|
+
* Messages API client
|
|
16
14
|
*/
|
|
17
15
|
declare class Messages {
|
|
18
|
-
|
|
16
|
+
readonly authRequired = true;
|
|
19
17
|
private readonly axios;
|
|
18
|
+
private readonly endpoint;
|
|
20
19
|
private readonly headers;
|
|
21
|
-
/**
|
|
22
|
-
* Creates an instance of the Messages class.
|
|
23
|
-
*
|
|
24
|
-
* @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
|
|
25
|
-
*/
|
|
26
20
|
constructor(api: MarketplaceApi);
|
|
27
21
|
/**
|
|
28
|
-
*
|
|
22
|
+
* Query messages in a transaction
|
|
29
23
|
*
|
|
30
24
|
* @template P
|
|
31
|
-
* @param {P & MessagesQueryParameter} params
|
|
32
|
-
* @returns {Promise<AxiosResponse<MessagesResponse<
|
|
25
|
+
* @param {P & MessagesQueryParameter} params
|
|
26
|
+
* @returns {Promise<AxiosResponse<MessagesResponse<"query", P>>>}
|
|
33
27
|
*
|
|
34
28
|
* @example
|
|
35
|
-
* const
|
|
36
|
-
*
|
|
29
|
+
* const { data } = await sdk.messages.query({
|
|
30
|
+
* transactionId: "tx-abc123"
|
|
31
|
+
* });
|
|
37
32
|
*/
|
|
38
33
|
query<P extends MessagesQueryParameter>(params: P): Promise<AxiosResponse<MessagesResponse<"query", P>>>;
|
|
39
34
|
/**
|
|
40
|
-
*
|
|
35
|
+
* Send a new message in a transaction
|
|
41
36
|
*
|
|
42
37
|
* @template P
|
|
43
38
|
* @template EP
|
|
44
|
-
* @param {P & MessagesSendParameter} params
|
|
45
|
-
* @param {EP
|
|
46
|
-
* @returns {Promise<AxiosResponse<MessagesResponse<
|
|
39
|
+
* @param {P & MessagesSendParameter} params
|
|
40
|
+
* @param {EP} [extraParams] - Optional extra parameters (e.g. `expand: true`)
|
|
41
|
+
* @returns {Promise<AxiosResponse<MessagesResponse<"send", P, EP>>>}
|
|
47
42
|
*
|
|
48
43
|
* @example
|
|
49
|
-
*
|
|
50
|
-
* transactionId:
|
|
44
|
+
* await sdk.messages.send({
|
|
45
|
+
* transactionId: "tx-abc123",
|
|
46
|
+
* content: "Hi! When are you available?"
|
|
51
47
|
* });
|
|
52
|
-
* const sentMessage = response.data;
|
|
53
48
|
*/
|
|
54
|
-
send<P extends MessagesSendParameter, EP extends ExtraParameter>(params: P, extraParams?: EP
|
|
49
|
+
send<P extends MessagesSendParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<MessagesResponse<"send", P, EP>>>;
|
|
55
50
|
}
|
|
56
51
|
export default Messages;
|
|
57
52
|
//# sourceMappingURL=Messages.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Messages.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Messages.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"Messages.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Messages.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EAAC,cAAc,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAE7G;;GAEG;AACH,cAAM,QAAQ;IACZ,SAAgB,YAAY,QAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;OAWG;IACG,KAAK,CAAC,CAAC,SAAS,sBAAsB,EAC1C,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAOvD;;;;;;;;;;;;;;OAcG;IACG,IAAI,CACR,CAAC,SAAS,qBAAqB,EAC/B,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;CAO3D;AAED,eAAe,QAAQ,CAAC"}
|
|
@@ -1,181 +1,117 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @fileoverview
|
|
3
|
-
* This class includes methods for creating, updating, publishing, and managing the lifecycle of listings.
|
|
2
|
+
* @fileoverview Client for managing your own listings in the Sharetribe Marketplace API.
|
|
4
3
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* Use this to create, edit, publish, close, and manage images for listings you own.
|
|
5
|
+
* All operations require authentication.
|
|
6
|
+
*
|
|
7
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#own-listings
|
|
7
8
|
*/
|
|
8
|
-
import { AxiosResponse } from "axios";
|
|
9
|
+
import type { AxiosResponse } from "axios";
|
|
9
10
|
import MarketplaceApi from "./index";
|
|
10
|
-
import { OwnListingsAddImageParameter, OwnListingsCloseParameter, OwnListingsCreateDraftParameter, OwnListingsCreateParameter, OwnListingsDiscardDraftParameter, OwnListingsOpenParameter, OwnListingsPublishDraftParameter, OwnListingsQueryParameter, OwnListingsResponse, OwnListingsShowParameter, OwnListingsUpdateParameter } from "../../types
|
|
11
|
-
import { ExtraParameter } from "../../types/sharetribe";
|
|
11
|
+
import { ExtraParameter, OwnListingsAddImageParameter, OwnListingsCloseParameter, OwnListingsCreateDraftParameter, OwnListingsCreateParameter, OwnListingsDiscardDraftParameter, OwnListingsOpenParameter, OwnListingsPublishDraftParameter, OwnListingsQueryParameter, OwnListingsResponse, OwnListingsShowParameter, OwnListingsUpdateParameter } from "../../types";
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* This class provides methods for the authenticated user to manage their listings, including creating, updating, publishing drafts, and adding images.
|
|
13
|
+
* Own Listings API client (authenticated user)
|
|
16
14
|
*/
|
|
17
15
|
declare class OwnListings {
|
|
18
|
-
|
|
16
|
+
readonly authRequired = true;
|
|
19
17
|
private readonly axios;
|
|
18
|
+
private readonly endpoint;
|
|
20
19
|
private readonly headers;
|
|
21
|
-
readonly authRequired = true;
|
|
22
|
-
/**
|
|
23
|
-
* Creates an instance of the OwnListings class.
|
|
24
|
-
*
|
|
25
|
-
* @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
|
|
26
|
-
*/
|
|
27
20
|
constructor(api: MarketplaceApi);
|
|
28
21
|
/**
|
|
29
|
-
*
|
|
22
|
+
* Fetch one of your listings by ID
|
|
30
23
|
*
|
|
31
24
|
* @template P
|
|
32
|
-
* @param {OwnListingsShowParameter} params
|
|
33
|
-
* @returns {Promise<AxiosResponse<OwnListingsResponse<
|
|
34
|
-
*
|
|
35
|
-
* @example
|
|
36
|
-
* const response = await sdk.ownListings.show({ id: 'listing-id' });
|
|
37
|
-
* const listing = response.data;
|
|
25
|
+
* @param {P & OwnListingsShowParameter} params
|
|
26
|
+
* @returns {Promise<AxiosResponse<OwnListingsResponse<"show", P>>>}
|
|
38
27
|
*/
|
|
39
28
|
show<P extends OwnListingsShowParameter>(params: P): Promise<AxiosResponse<OwnListingsResponse<"show", P>>>;
|
|
40
29
|
/**
|
|
41
|
-
*
|
|
30
|
+
* List all your listings (drafts, published, closed)
|
|
42
31
|
*
|
|
43
32
|
* @template P
|
|
44
|
-
* @param {OwnListingsQueryParameter} params
|
|
45
|
-
* @returns {Promise<AxiosResponse<OwnListingsResponse<
|
|
46
|
-
*
|
|
47
|
-
* @example
|
|
48
|
-
* const response = await sdk.ownListings.query({});
|
|
49
|
-
* const listings = response.data;
|
|
33
|
+
* @param {P & OwnListingsQueryParameter} params
|
|
34
|
+
* @returns {Promise<AxiosResponse<OwnListingsResponse<"query", P>>>}
|
|
50
35
|
*/
|
|
51
|
-
query<P extends OwnListingsQueryParameter>(params
|
|
36
|
+
query<P extends OwnListingsQueryParameter>(params?: P): Promise<AxiosResponse<OwnListingsResponse<"query", P>>>;
|
|
52
37
|
/**
|
|
53
|
-
*
|
|
38
|
+
* Create a published listing
|
|
54
39
|
*
|
|
55
40
|
* @template P
|
|
56
41
|
* @template EP
|
|
57
|
-
* @param {P & OwnListingsCreateParameter} params
|
|
58
|
-
* @param {EP
|
|
59
|
-
* @returns {Promise<AxiosResponse<OwnListingsResponse<
|
|
60
|
-
*
|
|
61
|
-
* @example
|
|
62
|
-
* const response = await sdk.ownListings.create({
|
|
63
|
-
* title: 'New Listing',
|
|
64
|
-
* description: 'Description',
|
|
65
|
-
* price: {
|
|
66
|
-
* amount: 1000,
|
|
67
|
-
* currency: 'USD'
|
|
68
|
-
* }
|
|
69
|
-
* });
|
|
70
|
-
* const newListing = response.data;
|
|
42
|
+
* @param {P & OwnListingsCreateParameter} params
|
|
43
|
+
* @param {EP} [extraParams]
|
|
44
|
+
* @returns {Promise<AxiosResponse<OwnListingsResponse<"create", P, EP>>>}
|
|
71
45
|
*/
|
|
72
|
-
create<P extends OwnListingsCreateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"create", P, EP>>>;
|
|
46
|
+
create<P extends OwnListingsCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"create", P, EP>>>;
|
|
73
47
|
/**
|
|
74
|
-
*
|
|
48
|
+
* Create a draft listing (for step-by-step creation)
|
|
75
49
|
*
|
|
76
50
|
* @template P
|
|
77
51
|
* @template EP
|
|
78
|
-
* @param {P & OwnListingsCreateDraftParameter} params
|
|
79
|
-
* @param {EP
|
|
80
|
-
* @returns {Promise<AxiosResponse<OwnListingsResponse<
|
|
81
|
-
*
|
|
82
|
-
* @example
|
|
83
|
-
* const response = await sdk.ownListings.createDraft({
|
|
84
|
-
* title: 'Draft Listing',
|
|
85
|
-
* description: 'This is a draft',
|
|
86
|
-
* });
|
|
87
|
-
* const draft = response.data;
|
|
52
|
+
* @param {P & OwnListingsCreateDraftParameter} params
|
|
53
|
+
* @param {EP} [extraParams]
|
|
54
|
+
* @returns {Promise<AxiosResponse<OwnListingsResponse<"createDraft", P, EP>>>}
|
|
88
55
|
*/
|
|
89
|
-
createDraft<P extends OwnListingsCreateDraftParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"createDraft", P, EP>>>;
|
|
56
|
+
createDraft<P extends OwnListingsCreateDraftParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"createDraft", P, EP>>>;
|
|
90
57
|
/**
|
|
91
|
-
*
|
|
58
|
+
* Update a listing (draft or published)
|
|
92
59
|
*
|
|
93
60
|
* @template P
|
|
94
61
|
* @template EP
|
|
95
|
-
* @param {P & OwnListingsUpdateParameter} params
|
|
96
|
-
* @param {EP
|
|
97
|
-
* @returns {Promise<AxiosResponse<OwnListingsResponse<
|
|
98
|
-
*
|
|
99
|
-
* @example
|
|
100
|
-
* const response = await sdk.ownListings.update({
|
|
101
|
-
* id: 'listing-id',
|
|
102
|
-
* title: 'Updated Listing Title',
|
|
103
|
-
* });
|
|
104
|
-
* const updatedListing = response.data;
|
|
62
|
+
* @param {P & OwnListingsUpdateParameter} params
|
|
63
|
+
* @param {EP} [extraParams]
|
|
64
|
+
* @returns {Promise<AxiosResponse<OwnListingsResponse<"update", P, EP>>>}
|
|
105
65
|
*/
|
|
106
|
-
update<P extends OwnListingsUpdateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"update", P, EP>>>;
|
|
66
|
+
update<P extends OwnListingsUpdateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"update", P, EP>>>;
|
|
107
67
|
/**
|
|
108
|
-
*
|
|
68
|
+
* Publish a draft listing
|
|
109
69
|
*
|
|
110
70
|
* @template P
|
|
111
71
|
* @template EP
|
|
112
|
-
* @param {P & OwnListingsPublishDraftParameter} params
|
|
113
|
-
* @param {EP
|
|
114
|
-
* @returns {Promise<AxiosResponse<OwnListingsResponse<
|
|
115
|
-
*
|
|
116
|
-
* @example
|
|
117
|
-
* const response = await sdk.ownListings.publishDraft({
|
|
118
|
-
* id: 'draft-id',
|
|
119
|
-
* });
|
|
120
|
-
* const publishedListing = response.data;
|
|
72
|
+
* @param {P & OwnListingsPublishDraftParameter} params
|
|
73
|
+
* @param {EP} [extraParams]
|
|
74
|
+
* @returns {Promise<AxiosResponse<OwnListingsResponse<"publishDraft", P, EP>>>}
|
|
121
75
|
*/
|
|
122
|
-
publishDraft<P extends OwnListingsPublishDraftParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"publishDraft", P, EP>>>;
|
|
76
|
+
publishDraft<P extends OwnListingsPublishDraftParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"publishDraft", P, EP>>>;
|
|
123
77
|
/**
|
|
124
|
-
*
|
|
78
|
+
* Discard a draft listing
|
|
125
79
|
*
|
|
126
80
|
* @template P
|
|
127
|
-
* @param {P & OwnListingsDiscardDraftParameter} params
|
|
128
|
-
* @returns {Promise<AxiosResponse<OwnListingsResponse<
|
|
129
|
-
*
|
|
130
|
-
* @example
|
|
131
|
-
* const response = await sdk.ownListings.discardDraft({ id: 'draft-id' });
|
|
132
|
-
* const result = response.data;
|
|
81
|
+
* @param {P & OwnListingsDiscardDraftParameter} params
|
|
82
|
+
* @returns {Promise<AxiosResponse<OwnListingsResponse<"discardDraft", P>>>}
|
|
133
83
|
*/
|
|
134
84
|
discardDraft<P extends OwnListingsDiscardDraftParameter>(params: P): Promise<AxiosResponse<OwnListingsResponse<"discardDraft", P>>>;
|
|
135
85
|
/**
|
|
136
|
-
*
|
|
86
|
+
* Close a published listing
|
|
137
87
|
*
|
|
138
88
|
* @template P
|
|
139
89
|
* @template EP
|
|
140
|
-
* @param {P & OwnListingsCloseParameter} params
|
|
141
|
-
* @param {EP
|
|
142
|
-
* @returns {Promise<AxiosResponse<OwnListingsResponse<
|
|
143
|
-
*
|
|
144
|
-
* @example
|
|
145
|
-
* const response = await sdk.ownListings.close({ id: 'listing-id' });
|
|
146
|
-
* const closedListing = response.data;
|
|
90
|
+
* @param {P & OwnListingsCloseParameter} params
|
|
91
|
+
* @param {EP} [extraParams]
|
|
92
|
+
* @returns {Promise<AxiosResponse<OwnListingsResponse<"close", P, EP>>>}
|
|
147
93
|
*/
|
|
148
|
-
close<P extends OwnListingsCloseParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"close", P>>>;
|
|
94
|
+
close<P extends OwnListingsCloseParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"close", P, EP>>>;
|
|
149
95
|
/**
|
|
150
|
-
*
|
|
96
|
+
* Re-open a closed listing
|
|
151
97
|
*
|
|
152
98
|
* @template P
|
|
153
99
|
* @template EP
|
|
154
|
-
* @param {P & OwnListingsOpenParameter} params
|
|
155
|
-
* @param {EP
|
|
156
|
-
* @returns {Promise<AxiosResponse<OwnListingsResponse<
|
|
157
|
-
*
|
|
158
|
-
* @example
|
|
159
|
-
* const response = await sdk.ownListings.open({ id: 'listing-id' });
|
|
160
|
-
* const openedListing = response.data;
|
|
100
|
+
* @param {P & OwnListingsOpenParameter} params
|
|
101
|
+
* @param {EP} [extraParams]
|
|
102
|
+
* @returns {Promise<AxiosResponse<OwnListingsResponse<"open", P, EP>>>}
|
|
161
103
|
*/
|
|
162
|
-
open<P extends OwnListingsOpenParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"open", P>>>;
|
|
104
|
+
open<P extends OwnListingsOpenParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"open", P, EP>>>;
|
|
163
105
|
/**
|
|
164
|
-
*
|
|
106
|
+
* Attach an uploaded image to a listing
|
|
165
107
|
*
|
|
166
108
|
* @template P
|
|
167
109
|
* @template EP
|
|
168
|
-
* @param {P & OwnListingsAddImageParameter} params
|
|
169
|
-
* @param {EP
|
|
170
|
-
* @returns {Promise<AxiosResponse<OwnListingsResponse<
|
|
171
|
-
*
|
|
172
|
-
* @example
|
|
173
|
-
* const response = await sdk.ownListings.addImage({
|
|
174
|
-
* id: 'listing-id', imageId: 'image-id'
|
|
175
|
-
* });
|
|
176
|
-
* const updatedListing = response.data;
|
|
110
|
+
* @param {P & OwnListingsAddImageParameter} params
|
|
111
|
+
* @param {EP} [extraParams]
|
|
112
|
+
* @returns {Promise<AxiosResponse<OwnListingsResponse<"addImage", P, EP>>>}
|
|
177
113
|
*/
|
|
178
|
-
addImage<P extends OwnListingsAddImageParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"addImage", P>>>;
|
|
114
|
+
addImage<P extends OwnListingsAddImageParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<OwnListingsResponse<"addImage", P, EP>>>;
|
|
179
115
|
}
|
|
180
116
|
export default OwnListings;
|
|
181
117
|
//# sourceMappingURL=OwnListings.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OwnListings.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/OwnListings.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"OwnListings.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/OwnListings.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,cAAc,EACd,4BAA4B,EAC5B,yBAAyB,EACzB,+BAA+B,EAC/B,0BAA0B,EAC1B,gCAAgC,EAChC,wBAAwB,EACxB,gCAAgC,EAChC,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAC3B,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,cAAM,WAAW;IACf,SAAgB,YAAY,QAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;OAMG;IACG,IAAI,CAAC,CAAC,SAAS,wBAAwB,EAC3C,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAOzD;;;;;;OAMG;IACG,KAAK,CAAC,CAAC,SAAS,yBAAyB,EAC7C,MAAM,CAAC,EAAE,CAAC,GACT,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAO1D;;;;;;;;OAQG;IACG,MAAM,CACV,CAAC,SAAS,0BAA0B,EACpC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ/D;;;;;;;;OAQG;IACG,WAAW,CACf,CAAC,SAAS,+BAA+B,EACzC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQpE;;;;;;;;OAQG;IACG,MAAM,CACV,CAAC,SAAS,0BAA0B,EACpC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ/D;;;;;;;;OAQG;IACG,YAAY,CAChB,CAAC,SAAS,gCAAgC,EAC1C,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQrE;;;;;;OAMG;IACG,YAAY,CAAC,CAAC,SAAS,gCAAgC,EAC3D,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC;IAQjE;;;;;;;;OAQG;IACG,KAAK,CACT,CAAC,SAAS,yBAAyB,EACnC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ9D;;;;;;;;OAQG;IACG,IAAI,CACR,CAAC,SAAS,wBAAwB,EAClC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ7D;;;;;;;;OAQG;IACG,QAAQ,CACZ,CAAC,SAAS,4BAA4B,EACtC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;CAOlE;AAED,eAAe,WAAW,CAAC"}
|
|
@@ -1,63 +1,51 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @fileoverview
|
|
3
|
-
* This class includes methods for requesting a password reset and resetting the password using a token.
|
|
2
|
+
* @fileoverview Client for password reset operations in the Sharetribe Marketplace API.
|
|
4
3
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* Use this to request a password-reset email and to complete the password reset flow.
|
|
5
|
+
*
|
|
6
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#password-reset
|
|
7
7
|
*/
|
|
8
|
-
import { AxiosResponse } from "axios";
|
|
8
|
+
import type { AxiosResponse } from "axios";
|
|
9
9
|
import MarketplaceApi from "./index";
|
|
10
|
-
import {
|
|
11
|
-
import { ExtraParameter } from "../../types/sharetribe";
|
|
10
|
+
import { ExtraParameter, PasswordResetRequestParameter, PasswordResetResetParameter, PasswordResetResponse } from "../../types";
|
|
12
11
|
/**
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* The Password Reset API provides methods for requesting a password reset email and resetting the password.
|
|
12
|
+
* Password Reset API client
|
|
16
13
|
*/
|
|
17
14
|
declare class PasswordReset {
|
|
18
|
-
private readonly endpoint;
|
|
19
15
|
private readonly axios;
|
|
16
|
+
private readonly endpoint;
|
|
20
17
|
private readonly headers;
|
|
21
|
-
/**
|
|
22
|
-
* Creates an instance of the PasswordReset class.
|
|
23
|
-
*
|
|
24
|
-
* @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
|
|
25
|
-
*/
|
|
26
18
|
constructor(api: MarketplaceApi);
|
|
27
19
|
/**
|
|
28
|
-
*
|
|
20
|
+
* Request a password-reset email
|
|
29
21
|
*
|
|
30
22
|
* @template P
|
|
31
23
|
* @template EP
|
|
32
|
-
* @param {P &
|
|
33
|
-
* @param {EP
|
|
34
|
-
* @returns {Promise<AxiosResponse<PasswordResetResponse<
|
|
24
|
+
* @param {P & PasswordResetRequestParameter} params
|
|
25
|
+
* @param {EP} [extraParams]
|
|
26
|
+
* @returns {Promise<AxiosResponse<PasswordResetResponse<"request", EP>>>}
|
|
35
27
|
*
|
|
36
28
|
* @example
|
|
37
|
-
*
|
|
38
|
-
* email: 'user@example.com',
|
|
39
|
-
* });
|
|
40
|
-
* const result = response.data;
|
|
29
|
+
* await sdk.passwordReset.request({ email: "user@example.com" });
|
|
41
30
|
*/
|
|
42
|
-
request<P extends
|
|
31
|
+
request<P extends PasswordResetRequestParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<PasswordResetResponse<"request", EP>>>;
|
|
43
32
|
/**
|
|
44
|
-
*
|
|
33
|
+
* Complete password reset using the token received by email
|
|
45
34
|
*
|
|
46
35
|
* @template P
|
|
47
36
|
* @template EP
|
|
48
|
-
* @param {P &
|
|
49
|
-
* @param {EP
|
|
50
|
-
* @returns {Promise<AxiosResponse<PasswordResetResponse<
|
|
37
|
+
* @param {P & PasswordResetResetParameter} params
|
|
38
|
+
* @param {EP} [extraParams]
|
|
39
|
+
* @returns {Promise<AxiosResponse<PasswordResetResponse<"reset", EP>>>}
|
|
51
40
|
*
|
|
52
41
|
* @example
|
|
53
|
-
*
|
|
54
|
-
* email:
|
|
55
|
-
* passwordResetToken:
|
|
56
|
-
* newPassword:
|
|
42
|
+
* await sdk.passwordReset.reset({
|
|
43
|
+
* email: "user@example.com",
|
|
44
|
+
* passwordResetToken: "abc123...",
|
|
45
|
+
* newPassword: "newSecurePassword123"
|
|
57
46
|
* });
|
|
58
|
-
* const result = response.data;
|
|
59
47
|
*/
|
|
60
|
-
reset<P extends
|
|
48
|
+
reset<P extends PasswordResetResetParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<PasswordResetResponse<"reset", EP>>>;
|
|
61
49
|
}
|
|
62
50
|
export default PasswordReset;
|
|
63
51
|
//# sourceMappingURL=PasswordReset.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PasswordReset.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/PasswordReset.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,
|
|
1
|
+
{"version":3,"file":"PasswordReset.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/PasswordReset.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,cAAc,EACd,6BAA6B,EAC7B,2BAA2B,EAC3B,qBAAqB,EACtB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,cAAM,aAAa;IACjB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;OAWG;IACG,OAAO,CACX,CAAC,SAAS,6BAA6B,EACvC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ/D;;;;;;;;;;;;;;;OAeG;IACG,KAAK,CACT,CAAC,SAAS,2BAA2B,EACrC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;CAO9D;AAED,eAAe,aAAa,CAAC"}
|
|
@@ -1,41 +1,41 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @fileoverview
|
|
3
|
-
* This class includes a method for querying process transitions.
|
|
2
|
+
* @fileoverview Client for querying process transitions in the Sharetribe Marketplace API.
|
|
4
3
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* Process transitions define the state machine of a transaction process (e.g. booking, sale).
|
|
5
|
+
* Use this endpoint to inspect available transitions and their parameters.
|
|
6
|
+
*
|
|
7
|
+
* @see https://www.sharetribe.com/api-reference/marketplace.html#process-transitions
|
|
7
8
|
*/
|
|
8
|
-
import { AxiosResponse } from "axios";
|
|
9
|
+
import type { AxiosResponse } from "axios";
|
|
9
10
|
import MarketplaceApi from "./index";
|
|
10
|
-
import { ProcessTransitionsQueryParameter, ProcessTransitionsResponse } from "../../types
|
|
11
|
+
import { ProcessTransitionsQueryParameter, ProcessTransitionsResponse } from "../../types";
|
|
11
12
|
/**
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* The Process Transitions API provides methods for querying transitions within processes.
|
|
13
|
+
* Process Transitions API client
|
|
15
14
|
*/
|
|
16
15
|
declare class ProcessTransitions {
|
|
17
|
-
|
|
16
|
+
readonly authRequired = true;
|
|
18
17
|
private readonly axios;
|
|
18
|
+
private readonly endpoint;
|
|
19
19
|
private readonly headers;
|
|
20
|
-
readonly authRequired = true;
|
|
21
|
-
/**
|
|
22
|
-
* Creates an instance of the ProcessTransitions class.
|
|
23
|
-
*
|
|
24
|
-
* @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
|
|
25
|
-
*/
|
|
26
20
|
constructor(api: MarketplaceApi);
|
|
27
21
|
/**
|
|
28
|
-
*
|
|
22
|
+
* Query available process transitions
|
|
29
23
|
*
|
|
30
24
|
* @template P
|
|
31
|
-
* @param {P & ProcessTransitionsQueryParameter} params
|
|
32
|
-
* @returns {Promise<AxiosResponse<ProcessTransitionsResponse<
|
|
25
|
+
* @param {P & ProcessTransitionsQueryParameter} params
|
|
26
|
+
* @returns {Promise<AxiosResponse<ProcessTransitionsResponse<"query">>>}
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* // Fetch all transitions for the default booking process
|
|
30
|
+
* const { data } = await sdk.processTransitions.query({
|
|
31
|
+
* processAlias: "default-booking"
|
|
32
|
+
* });
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
|
-
*
|
|
36
|
-
*
|
|
35
|
+
* // Inspect a specific transition
|
|
36
|
+
* await sdk.processTransitions.query({
|
|
37
|
+
* lastTransition: "transition/confirm-payment"
|
|
37
38
|
* });
|
|
38
|
-
* const transitions = response.data;
|
|
39
39
|
*/
|
|
40
40
|
query<P extends ProcessTransitionsQueryParameter>(params: P): Promise<AxiosResponse<ProcessTransitionsResponse<"query">>>;
|
|
41
41
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ProcessTransitions.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/ProcessTransitions.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"ProcessTransitions.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/ProcessTransitions.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EAAC,gCAAgC,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAE1F;;GAEG;AACH,cAAM,kBAAkB;IACtB,SAAgB,YAAY,QAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;;;;;;OAkBG;IACG,KAAK,CAAC,CAAC,SAAS,gCAAgC,EACpD,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,0BAA0B,CAAC,OAAO,CAAC,CAAC,CAAC;CAM/D;AAED,eAAe,kBAAkB,CAAC"}
|