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

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

@@ -1,77 +1,63 @@
 /**
- * @fileoverview Provides the StripeCustomer class for managing Stripe customers in the Sharetribe Marketplace API.
- * This class includes methods for creating customers, adding payment methods, and deleting payment methods.
+ * @fileoverview Client for managing the current user's Stripe Customer object in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#stripe-customer
+ * Use this to:
+ * - Create a Stripe Customer (required for charging users)
+ * - Attach payment methods (e.g. saved cards)
+ * - Remove payment methods
+ *
+ * All operations are performed on the current authenticated user.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#stripe-customer
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { StripeCustomerAddPaymentMethodParameter, StripeCustomerCreateParameter, StripeCustomerDeletePaymentMethodParameter, StripeCustomerResponse } from "../../types/marketplace/stripeCustomer";
-import { ExtraParameter } from "../../types/sharetribe";
+import { ExtraParameter, StripeCustomerAddPaymentMethodParameter, StripeCustomerCreateParameter, StripeCustomerDeletePaymentMethodParameter, StripeCustomerResponse } from "../../types";
 /**
- * Class representing the Stripe Customer API.
- *
- * The Stripe Customer API provides methods for managing Stripe customers, including creating customers and managing payment methods.
+ * Stripe Customer API client (current user)
  */
 declare class StripeCustomer {
-    private readonly endpoint;
+    readonly authRequired = true;
     private readonly axios;
+    private readonly endpoint;
     private readonly headers;
-    readonly authRequired = true;
-    /**
-     * Creates an instance of the StripeCustomer class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
     constructor(api: MarketplaceApi);
     /**
-     * Creates a new Stripe customer.
+     * Create a Stripe Customer for the current user
      *
      * @template P
      * @template EP
-     * @param {P & StripeCustomerCreateParameter} params - Parameters for creating the Stripe customer.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<StripeCustomerResponse<'create', P, EP>>>} - A promise resolving to the created customer details.
+     * @param {P & StripeCustomerCreateParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<StripeCustomerResponse<"create", P, EP>>>}
      *
      * @example
-     * const response = await sdk.stripeCustomer.create({
-     *   stripePaymentMethodId: 'payment-method-id',
-     *   stripeCustomerEmail: 'user@example.com'
+     * await sdk.stripeCustomer.create({
+     *   stripePaymentMethodId: "pm_card_visa",
+     *   stripeCustomerEmail: "user@example.com"
      * });
-     * const customer = response.data;
      */
-    create<P extends StripeCustomerCreateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeCustomerResponse<"create", P, EP>>>;
+    create<P extends StripeCustomerCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeCustomerResponse<"create", P, EP>>>;
     /**
-     * Adds a payment method to a Stripe customer.
+     * Attach a new payment method to the current user's Stripe Customer
      *
      * @template P
      * @template EP
-     * @param {P & StripeCustomerAddPaymentMethodParameter} params - Parameters for adding a payment method.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<StripeCustomerResponse<'addPaymentMethod', P, EP>>>} - A promise resolving to the updated customer details.
-     *
-     * @example
-     * const response = await sdk.stripeCustomer.addPaymentMethod({
-     *   stripePaymentMethodId: 'payment-method-id'
-     * });
-     * const updatedCustomer = response.data;
+     * @param {P & StripeCustomerAddPaymentMethodParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<StripeCustomerResponse<"addPaymentMethod", P, EP>>>}
      */
-    addPaymentMethod<P extends StripeCustomerAddPaymentMethodParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeCustomerResponse<"addPaymentMethod", P, EP>>>;
+    addPaymentMethod<P extends StripeCustomerAddPaymentMethodParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeCustomerResponse<"addPaymentMethod", P, EP>>>;
     /**
-     * Deletes a payment method from a Stripe customer.
+     * Remove a saved payment method
      *
      * @template P
      * @template EP
-     * @param {P & StripeCustomerDeletePaymentMethodParameter} params - Parameters for deleting the payment method.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<StripeCustomerResponse<'deletePaymentMethod', P>>>} - A promise resolving to the confirmation of deletion.
-     *
-     * @example
-     * const response = await sdk.stripeCustomer.deletePaymentMethod({ customer_id: 'customer-id', payment_method_id: 'payment-method-id' });
-     * const result = response.data;
+     * @param {P & StripeCustomerDeletePaymentMethodParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<StripeCustomerResponse<"deletePaymentMethod", P, EP>>>}
      */
-    deletePaymentMethod<P extends StripeCustomerDeletePaymentMethodParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeCustomerResponse<"deletePaymentMethod", P, EP>>>;
+    deletePaymentMethod<P extends StripeCustomerDeletePaymentMethodParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeCustomerResponse<"deletePaymentMethod", P, EP>>>;
 }
 export default StripeCustomer;
 //# sourceMappingURL=StripeCustomer.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"StripeCustomer.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/StripeCustomer.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,uCAAuC,EACvC,6BAA6B,EAC7B,0CAA0C,EAC1C,sBAAsB,EACvB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,cAAc;IAClB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,SAAgB,YAAY,QAAQ;IAEpC;;;;OAIG;gBACS,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;;;OAeG;IACG,MAAM,CACV,CAAC,SAAS,6BAA6B,EACvC,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,sBAAsB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQlE;;;;;;;;;;;;;;OAcG;IACG,gBAAgB,CACpB,CAAC,SAAS,uCAAuC,EACjD,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,sBAAsB,CAAC,kBAAkB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ5E;;;;;;;;;;;;OAYG;IACG,mBAAmB,CACvB,CAAC,SAAS,0CAA0C,EACpD,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CACR,aAAa,CAAC,sBAAsB,CAAC,qBAAqB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CACpE;CASF;AAED,eAAe,cAAc,CAAC"}
+{"version":3,"file":"StripeCustomer.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/StripeCustomer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,cAAc,EACd,uCAAuC,EACvC,6BAA6B,EAC7B,0CAA0C,EAC1C,sBAAsB,EACvB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,cAAM,cAAc;IAClB,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;;;;;;;;;;;;;;OAcG;IACG,MAAM,CACV,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,sBAAsB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQlE;;;;;;;;OAQG;IACG,gBAAgB,CACpB,CAAC,SAAS,uCAAuC,EACjD,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,sBAAsB,CAAC,kBAAkB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ5E;;;;;;;;OAQG;IACG,mBAAmB,CACvB,CAAC,SAAS,0CAA0C,EACpD,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,sBAAsB,CAAC,qBAAqB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;CAOhF;AAED,eAAe,cAAc,CAAC"}

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

@@ -1,46 +1,38 @@
 /**
- * @fileoverview Provides the StripePersons class for managing Stripe persons in the Sharetribe Marketplace API.
- * This class includes methods for creating persons associated with Stripe accounts.
+ * @fileoverview Client for creating Stripe Persons in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#stripe-persons
+ * A "Person" represents an individual associated with a Stripe Connect account
+ * (e.g. owner, director, representative). Required for compliance in many countries.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#stripe-persons
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { StripePersonsCreateParameter, StripePersonsResponse } from "../../types/marketplace/stripePersons";
-import { ExtraParameter } from "../../types/sharetribe";
+import { ExtraParameter, StripePersonsCreateParameter, StripePersonsResponse } from "../../types";
 /**
- * Class representing the Stripe Persons API.
- *
- * The Stripe Persons API provides methods for creating persons associated with Stripe accounts, used for compliance and verification purposes.
+ * Stripe Persons API client (current user)
  */
 declare class StripePersons {
-    private readonly endpoint;
+    readonly authRequired = true;
     private readonly axios;
+    private readonly endpoint;
     private readonly headers;
-    readonly authRequired = true;
-    /**
-     * Creates an instance of the StripePersons class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
     constructor(api: MarketplaceApi);
     /**
-     * Creates a new person for a Stripe account.
+     * Create a new Person for the current user's Stripe Connect account
      *
      * @template P
      * @template EP
-     * @param {P & StripePersonsCreateParameter} params - Parameters for creating the Stripe person.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<StripePersonsResponse<'create'>>>} - A promise resolving to the created person details.
+     * @param {P & StripePersonsCreateParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<StripePersonsResponse<"create">>>}
      *
      * @example
-     * const response = await sdk.stripePersons.create({
-     *   personToken: 'person-token',
+     * await sdk.stripePersons.create({
+     *   personToken: "person_tok_1AbC2DeFGhiJkLMnOPqRsTuV"
      * });
-     * const personDetails = response.data;
      */
-    create<P extends StripePersonsCreateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<StripePersonsResponse<"create">>>;
+    create<P extends StripePersonsCreateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<StripePersonsResponse<"create">>>;
 }
 export default StripePersons;
 //# sourceMappingURL=StripePersons.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"StripePersons.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/StripePersons.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,aAAa;IACjB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,SAAgB,YAAY,QAAQ;IAEpC;;;;OAIG;gBACS,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;;OAcG;IACG,MAAM,CACV,CAAC,SAAS,4BAA4B,EACtC,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC;CAO3D;AAED,eAAe,aAAa,CAAC"}
+{"version":3,"file":"StripePersons.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/StripePersons.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,4BAA4B,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEjG;;GAEG;AACH,cAAM,aAAa;IACjB,SAAgB,YAAY,QAAQ;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;OAaG;IACG,MAAM,CACV,CAAC,SAAS,4BAA4B,EACtC,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC;CAO3D;AAED,eAAe,aAAa,CAAC"}

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

@@ -1,43 +1,43 @@
 /**
- * @fileoverview Provides the StripeSetupIntents class for managing Stripe Setup Intents in the Sharetribe Marketplace API.
- * This class includes methods for creating Stripe Setup Intents to set up payment methods for future use.
+ * @fileoverview Client for creating Stripe Setup Intents in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#create-stripe-person
+ * A Setup Intent is used to save a payment method (e.g. card) for future use
+ * without charging immediately — ideal for marketplaces that charge later.
+ *
+ * Returns `client_secret` for use with Stripe.js / Elements.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#stripe-setup-intents
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { StripeSetupIntentsCreateParameter, StripeSetupIntentsResponse } from "../../types/marketplace/stripeSetupIntents";
-import { ExtraParameter } from "../../types/sharetribe";
+import { ExtraParameter, StripeSetupIntentsCreateParameter, StripeSetupIntentsResponse } from "../../types";
 /**
- * Class representing the Stripe Setup Intents API.
- *
- * The Stripe Setup Intents API provides methods to securely create Setup Intents for Stripe payments.
+ * Stripe Setup Intents API client (current user)
  */
 declare class StripeSetupIntents {
-    private readonly endpoint;
-    private readonly axios;
     readonly authRequired = true;
-    /**
-     * Creates an instance of the StripeSetupIntents class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
+    private readonly axios;
+    private readonly endpoint;
+    private readonly headers;
     constructor(api: MarketplaceApi);
     /**
-     * Creates a new Stripe Setup Intent.
+     * Create a new Setup Intent for saving a payment method
      *
      * @template P
      * @template EP
-     * @param {P & StripeSetupIntentsCreateParameter} params - Parameters required to create the Stripe Setup Intent.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<StripeSetupIntentsResponse<'create'>>>} - A promise resolving to the created Setup Intent details.
+     * @param {P & StripeSetupIntentsCreateParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<StripeSetupIntentsResponse<"create">>>}
      *
      * @example
-     * const response = await sdk.stripeSetupIntents.create({});
-     * const setupIntentDetails = response.data;
+     * const { data } = await sdk.stripeSetupIntents.create({});
+     *
+     * // Use with Stripe.js
+     * stripe.confirmCardSetup(data.attributes.clientSecret, {
+     *   payment_method: { card: cardElement }
+     * });
      */
-    create<P extends StripeSetupIntentsCreateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<StripeSetupIntentsResponse<"create">>>;
+    create<P extends StripeSetupIntentsCreateParameter, EP extends ExtraParameter | undefined = undefined>(params?: P, extraParams?: EP): Promise<AxiosResponse<StripeSetupIntentsResponse<"create">>>;
 }
 export default StripeSetupIntents;
 //# sourceMappingURL=StripeSetupIntents.d.ts.map

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

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

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

@@ -1,42 +1,39 @@
 /**
- * @fileoverview Provides the TimeSlots class for managing time slots in the Sharetribe Marketplace API.
- * This class includes methods for querying available time slots for marketplace resources.
+ * @fileoverview Client for querying time slots in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#time-slots
+ * Use this to fetch availability for listings that use time-based booking
+ * (e.g. hourly rentals, appointments, classes).
+ *
+ * Returns day or time-range slots with seat availability.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#time-slots
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { TimeSlotsQueryParameter, TimeSlotsResponse } from "../../types/marketplace/timeSlots";
+import { TimeSlotsQueryParameter, TimeSlotsResponse } from "../../types";
 /**
- * Class representing the Time Slots API.
- *
- * The Time Slots API provides methods for querying available time slots for bookings.
+ * Time Slots API client
  */
 declare class TimeSlots {
-    private readonly endpoint;
     private readonly axios;
+    private readonly endpoint;
     private readonly headers;
-    /**
-     * Creates an instance of the TimeSlots class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
     constructor(api: MarketplaceApi);
     /**
-     * Queries available time slots based on specified filters.
+     * Query available time slots for a listing
      *
      * @template P
-     * @param {P & TimeSlotsQueryParameter} params - Query parameters for filtering time slots.
-     * @returns {Promise<AxiosResponse<TimeSlotsResponse<'query'>>>} - A promise resolving to the query results.
+     * @param {P & TimeSlotsQueryParameter} params
+     * @returns {Promise<AxiosResponse<TimeSlotsResponse<"query">>>}
      *
      * @example
-     * const response = await sdk.timeSlots.query({
-     *   listingId: 'listing-id',
-     *   start: '2024-01-01T00:00:00Z',
-     *   end: '2024-01-07T23:59:59Z',
+     * const { data } = await sdk.timeSlots.query({
+     *   listingId: "listing-abc123",
+     *   start: "2025-06-01T00:00:00Z",
+     *   end: "2025-06-07T23:59:59Z"
      * });
-     * const timeSlots = response.data;
+     *
+     * // `data` contains TimeSlot[] with `seats` and `start`/`end`
      */
     query<P extends TimeSlotsQueryParameter>(params: P): Promise<AxiosResponse<TimeSlotsResponse<"query">>>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"TimeSlots.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/TimeSlots.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EAClB,MAAM,mCAAmC,CAAC;AAE3C;;;;GAIG;AACH,cAAM,SAAS;IACb,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IAEjD;;;;OAIG;gBACS,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;;OAcG;IACG,KAAK,CAAC,CAAC,SAAS,uBAAuB,EAC3C,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;CAStD;AAED,eAAe,SAAS,CAAC"}
+{"version":3,"file":"TimeSlots.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/TimeSlots.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EAAC,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAExE;;GAEG;AACH,cAAM,SAAS;IACb,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;;;;OAeG;IACG,KAAK,CAAC,CAAC,SAAS,uBAAuB,EAC3C,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;CAMtD;AAED,eAAe,SAAS,CAAC"}

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

@@ -1,126 +1,90 @@
 /**
- * @fileoverview Provides the Transactions class for managing transactions in the Sharetribe Marketplace API.
- * This class includes methods for querying, initiating, transitioning, and managing transactions.
+ * @fileoverview Client for managing transactions in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#transactions
+ * Use this to:
+ * - Query your own transactions
+ * - Initiate new orders/inquiries
+ * - Transition transactions (accept, complete, cancel, etc.)
+ * - Perform speculative transitions (dry-run)
+ *
+ * All operations require authentication.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#transactions
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { TransactionsInitiateParameter, TransactionsInitiateSpeculativeParameter, TransactionsQueryParameter, TransactionsResponse, TransactionsShowParameter, TransactionsTransitionParameter, TransactionsTransitionSpeculativeParameter } from "../../types/marketplace/transactions";
-import { ExtraParameter } from "../../types/sharetribe";
+import { ExtraParameter, TransactionsInitiateParameter, TransactionsInitiateSpeculativeParameter, TransactionsQueryParameter, TransactionsResponse, TransactionsShowParameter, TransactionsTransitionParameter, TransactionsTransitionSpeculativeParameter } from "../../types";
 /**
- * Class representing the Transactions API.
- *
- * The Transactions API provides methods for managing marketplace transactions, including querying, initiating, and transitioning them.
+ * Transactions API client (current user)
  */
 declare class Transactions {
-    private readonly endpoint;
+    readonly authRequired = true;
     private readonly axios;
+    private readonly endpoint;
     private readonly headers;
-    readonly authRequired = true;
-    /**
-     * Creates an instance of the Transactions class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
     constructor(api: MarketplaceApi);
     /**
-     * Retrieves details of a specific transaction.
+     * Fetch a single transaction by ID
      *
      * @template P
-     * @param {P & TransactionsShowParameter} params - Parameters to identify the transaction.
-     * @returns {Promise<AxiosResponse<TransactionsResponse<'show', P>>>} - A promise resolving to the transaction details.
-     *
-     * @example
-     * const response = await sdk.transactions.show({ id: 'transaction-id' });
-     * const transactionDetails = response.data;
+     * @param {P & TransactionsShowParameter} params
+     * @returns {Promise<AxiosResponse<TransactionsResponse<"show", P>>>}
      */
     show<P extends TransactionsShowParameter>(params: P): Promise<AxiosResponse<TransactionsResponse<"show", P>>>;
     /**
-     * Queries transactions based on specified filters.
+     * Query your own transactions
      *
      * @template P
-     * @param {P & TransactionsQueryParameter} params - Query parameters for filtering transactions.
-     * @returns {Promise<AxiosResponse<TransactionsResponse<'query', P>>>} - A promise resolving to the query results.
-     *
-     * @example
-     * const response = await sdk.transactions.query({ perPage: 10 });
-     * const transactions = response.data;
+     * @param {P & TransactionsQueryParameter} params
+     * @returns {Promise<AxiosResponse<TransactionsResponse<"query", P>>>}
      */
-    query<P extends TransactionsQueryParameter>(params: P): Promise<AxiosResponse<TransactionsResponse<"query", P>>>;
+    query<P extends TransactionsQueryParameter>(params?: P): Promise<AxiosResponse<TransactionsResponse<"query", P>>>;
     /**
-     * Initiates a new transaction.
+     * Initiate a new transaction (e.g. place an order)
      *
      * @template P
      * @template EP
-     * @param {P & TransactionsInitiateParameter} params - Parameters for initiating the transaction.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<TransactionsResponse<'initiate', P, EP>>>} - A promise resolving to the initiated transaction details.
-     *
-     * @example
-     * const response = await sdk.transactions.initiate({
-     *   processAlias: 'order',
-     *   transition: 'start',
-     *   params: {}
-     * });
-     * const initiatedTransaction = response.data;
+     * @param {P & TransactionsInitiateParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<TransactionsResponse<"initiate", P, EP>>>}
      */
-    initiate<P extends TransactionsInitiateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"initiate", P, EP>>>;
+    initiate<P extends TransactionsInitiateParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"initiate", P, EP>>>;
     /**
-     * Initiates a speculative transaction.
+     * Initiate a transaction speculatively (dry-run)
      *
      * @template P
      * @template EP
-     * @param {P & TransactionsInitiateSpeculativeParameter} params - Parameters for the speculative transaction initiation.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<TransactionsResponse<'initiateSpeculative', P, EP>>>} - A promise resolving to the speculative transaction details.
-     *
-     * @example
-     * const response = await sdk.transactions.initiateSpeculative({
-     *   processAlias: 'order',
-     *   transition: 'start',
-     *   params: {}
-     * });
-     * const speculativeTransaction = response.data;
+     * @param {P & TransactionsInitiateSpeculativeParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<TransactionsResponse<"initiateSpeculative", P, EP>>>}
      */
-    initiateSpeculative<P extends TransactionsInitiateSpeculativeParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"initiateSpeculative", P, EP>>>;
+    initiateSpeculative<P extends TransactionsInitiateSpeculativeParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"initiateSpeculative", P, EP>>>;
     /**
-     * Transitions an existing transaction.
+     * Transition a transaction to a new state
      *
      * @template P
      * @template EP
-     * @param {P & TransactionsTransitionParameter} params - Parameters for transitioning the transaction.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<TransactionsResponse<'transition', P, EP>>>} - A promise resolving to the transitioned transaction details.
+     * @param {P & TransactionsTransitionParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<TransactionsResponse<"transition", P, EP>>>}
      *
      * @example
-     * const response = await sdk.transactions.transition({
-     *   id: 'transaction-id',
-     *   transition: 'complete',
-     *   params: { review: 5 }
+     * await sdk.transactions.transition({
+     *   id: "tx-abc123",
+     *   transition: "transition/confirm-payment"
      * });
-     * const transitionedTransaction = response.data;
      */
-    transition<P extends TransactionsTransitionParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"transition", P, EP>>>;
+    transition<P extends TransactionsTransitionParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"transition", P, EP>>>;
     /**
-     * Transitions a speculative transaction.
+     * Perform a speculative transition (dry-run)
      *
      * @template P
      * @template EP
-     * @param {P & TransactionsTransitionSpeculativeParameter} params - Parameters for the speculative transaction transition.
-     * @param {EP | void} extraParams - Optional extra parameters for the request.
-     * @returns {Promise<AxiosResponse<TransactionsResponse<'transitionSpeculative', P, EP>>>} - A promise resolving to the speculative transitioned transaction details.
-     *
-     * @example
-     * const response = await sdk.transactions.transitionSpeculative({
-     *   id: 'transaction-id',
-     *   transition: 'complete',
-     *   params: { review: 5 }
-     * });
-     * const speculativeTransitionedTransaction = response.data;
+     * @param {P & TransactionsTransitionSpeculativeParameter} params
+     * @param {EP} [extraParams]
+     * @returns {Promise<AxiosResponse<TransactionsResponse<"transitionSpeculative", P, EP>>>}
      */
-    transitionSpeculative<P extends TransactionsTransitionSpeculativeParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"transitionSpeculative", P, EP>>>;
+    transitionSpeculative<P extends TransactionsTransitionSpeculativeParameter, EP extends ExtraParameter | undefined = undefined>(params: P, extraParams?: EP): Promise<AxiosResponse<TransactionsResponse<"transitionSpeculative", P, EP>>>;
 }
 export default Transactions;
 //# sourceMappingURL=Transactions.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Transactions.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Transactions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,6BAA6B,EAC7B,wCAAwC,EACxC,0BAA0B,EAC1B,oBAAoB,EACpB,yBAAyB,EACzB,+BAA+B,EAC/B,0CAA0C,EAC3C,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,YAAY;IAChB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,SAAgB,YAAY,QAAQ;IAEpC;;;;OAIG;gBACS,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;OAUG;IACG,IAAI,CAAC,CAAC,SAAS,yBAAyB,EAC5C,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAU1D;;;;;;;;;;OAUG;IACG,KAAK,CAAC,CAAC,SAAS,0BAA0B,EAC9C,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAU3D;;;;;;;;;;;;;;;;OAgBG;IACG,QAAQ,CACZ,CAAC,SAAS,6BAA6B,EACvC,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQlE;;;;;;;;;;;;;;;;OAgBG;IACG,mBAAmB,CACvB,CAAC,SAAS,wCAAwC,EAClD,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CACR,aAAa,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAClE;IAQD;;;;;;;;;;;;;;;;OAgBG;IACG,UAAU,CACd,CAAC,SAAS,+BAA+B,EACzC,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQpE;;;;;;;;;;;;;;;;OAgBG;IACG,qBAAqB,CACzB,CAAC,SAAS,0CAA0C,EACpD,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CACR,aAAa,CAAC,oBAAoB,CAAC,uBAAuB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CACpE;CASF;AAED,eAAe,YAAY,CAAC"}
+{"version":3,"file":"Transactions.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Transactions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,cAAc,EACd,6BAA6B,EAC7B,wCAAwC,EACxC,0BAA0B,EAC1B,oBAAoB,EACpB,yBAAyB,EACzB,+BAA+B,EAC/B,0CAA0C,EAC3C,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,cAAM,YAAY;IAChB,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,yBAAyB,EAC5C,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAO1D;;;;;;OAMG;IACG,KAAK,CAAC,CAAC,SAAS,0BAA0B,EAC9C,MAAM,CAAC,EAAE,CAAC,GACT,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAO3D;;;;;;;;OAQG;IACG,QAAQ,CACZ,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,oBAAoB,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQlE;;;;;;;;OAQG;IACG,mBAAmB,CACvB,CAAC,SAAS,wCAAwC,EAClD,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,qBAAqB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ7E;;;;;;;;;;;;;;OAcG;IACG,UAAU,CACd,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,oBAAoB,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQpE;;;;;;;;OAQG;IACG,qBAAqB,CACzB,CAAC,SAAS,0CAA0C,EACpD,EAAE,SAAS,cAAc,GAAG,SAAS,GAAG,SAAS,EAEjD,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,uBAAuB,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;CAOhF;AAED,eAAe,YAAY,CAAC"}

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

@@ -1,40 +1,33 @@
 /**
- * @fileoverview Provides the Users class for managing user data in the Sharetribe Marketplace API.
- * This class includes methods for retrieving details about a specific user.
+ * @fileoverview Client for fetching public user profiles in the Sharetribe Marketplace API.
  *
- * For more details, refer to the Marketplace API documentation:
- * https://www.sharetribe.com/api-reference/marketplace.html#show-user
+ * Use this to retrieve publicly visible information about any user (e.g. name, bio, profile image).
+ * Only returns data the current user is allowed to see.
+ *
+ * @see https://www.sharetribe.com/api-reference/marketplace.html#show-user
  */
-import { AxiosResponse } from "axios";
+import type { AxiosResponse } from "axios";
 import MarketplaceApi from "./index";
-import { UsersResponse, UsersShowParameter } from "../../types/marketplace/user";
+import { UsersResponse, UsersShowParameter } from "../../types";
 /**
- * Class representing the Users API.
- *
- * The Users API provides methods for managing user data in the marketplace.
+ * Public Users API client
  */
 declare class Users {
-    private readonly endpoint;
     private readonly axios;
+    private readonly endpoint;
     private readonly headers;
-    /**
-     * Creates an instance of the Users class.
-     *
-     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
-     */
     constructor(api: MarketplaceApi);
     /**
-     * Retrieves details of a specific user.
+     * Fetch a public user profile by ID
      *
      * @template P
-     * @param {P & UsersShowParameter} params - Parameters to identify the user.
-     * @returns {Promise<AxiosResponse<UsersResponse<'show', P>>>} - A promise resolving to the user details.
+     * @param {P & UsersShowParameter} params
+     * @returns {Promise<AxiosResponse<UsersResponse<"show", P>>>}
      *
      * @example
-     * const response = await sdk.users.show({
-     *   id: 'user-id',
-     * });
-     * const userDetails = response.data;
+     * const { data } = await sdk.users.show({ id: "user-abc123" });
+     * console.log(data.attributes.profile.displayName);
+     * console.log(data.attributes.profile.bio);
      */
     show<P extends UsersShowParameter>(params: P): Promise<AxiosResponse<UsersResponse<"show", P>>>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"Users.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Users.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,aAAa,EACb,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AAEtC;;;;GAIG;AACH,cAAM,KAAK;IACT,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAgB;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IAEjD;;;;OAIG;gBACS,GAAG,EAAE,cAAc;IAM/B;;;;;;;;;;;;OAYG;IACG,IAAI,CAAC,CAAC,SAAS,kBAAkB,EACrC,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;CAMpD;AAED,eAAe,KAAK,CAAC"}
+{"version":3,"file":"Users.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/marketplace/Users.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAgB,aAAa,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EAAC,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAE/D;;GAEG;AACH,cAAM,KAAK;IACT,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,IAAI,CAAC,CAAC,SAAS,kBAAkB,EACrC,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;CAMpD;AAED,eAAe,KAAK,CAAC"}