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

package/dist/integrationSdk.d.ts

@@ -0,0 +1,119 @@
+import { ApiConfigs, SdkConfig } from "./types";
+import { AxiosInstance } from "axios";
+import IntegrationApi from "./endpoints/integrationApi";
+import AuthenticationApi from "./endpoints/auth";
+import AvailabilityExceptions from "./endpoints/integrationApi/AvailabilityExceptions";
+import Events from "./endpoints/integrationApi/Events";
+import Images from "./endpoints/integrationApi/Images";
+import Listings from "./endpoints/integrationApi/Listings";
+import Marketplace from "./endpoints/integrationApi/Marketplace";
+import Stock from "./endpoints/integrationApi/Stock";
+import StockAdjustments from "./endpoints/integrationApi/StockAdjustments";
+import StockReservations from "./endpoints/integrationApi/StockReservations";
+import Transactions from "./endpoints/integrationApi/Transactions";
+import Users from "./endpoints/integrationApi/Users";
+/**
+ * The main Sharetribe Integration SDK for interacting with the Sharetribe Integration API.
+ *
+ * @class
+ */
+declare class IntegrationSdk {
+    /**
+     * Configuration for the SDK.
+     *
+     * @type {SdkConfig}
+     */
+    sdkConfig: SdkConfig;
+    /**
+     * Configuration for the API endpoints.
+     *
+     * @type {ApiConfigs<true>}
+     */
+    apisConfigs: ApiConfigs<true>;
+    /**
+     * Axios instance used for making API requests.
+     *
+     * @type {AxiosInstance}
+     */
+    axios: AxiosInstance;
+    /**
+     * Endpoint for handling authentication.
+     *
+     * @type {AuthenticationApi}
+     */
+    auth: AuthenticationApi;
+    /**
+     * Main integration API.
+     *
+     * @type {IntegrationApi}
+     */
+    integration_api: IntegrationApi;
+    /**
+     * Endpoint for managing availability exceptions.
+     *
+     * @type {AvailabilityExceptions}
+     */
+    availabilityExceptions: AvailabilityExceptions;
+    /**
+     * Endpoint for retrieving and managing events.
+     *
+     * @type {Events}
+     */
+    events: Events;
+    /**
+     * Endpoint for handling image-related operations.
+     *
+     * @type {Images}
+     */
+    images: Images;
+    /**
+     * Endpoint for managing listings.
+     *
+     * @type {Listings}
+     */
+    listings: Listings;
+    /**
+     * Endpoint for accessing marketplace details.
+     *
+     * @type {Marketplace}
+     */
+    marketplace: Marketplace;
+    /**
+     * Endpoint for managing stock.
+     *
+     * @type {Stock}
+     */
+    stock: Stock;
+    /**
+     * Endpoint for handling stock adjustments.
+     *
+     * @type {StockAdjustments}
+     */
+    stockAdjustments: StockAdjustments;
+    /**
+     * Endpoint for managing stock reservations.
+     *
+     * @type {StockReservations}
+     */
+    stockReservations: StockReservations;
+    /**
+     * Endpoint for managing transactions.
+     *
+     * @type {Transactions}
+     */
+    transactions: Transactions;
+    /**
+     * Endpoint for managing user data.
+     *
+     * @type {Users}
+     */
+    users: Users;
+    /**
+     * Initializes a new instance of the SharetribeIntegrationSdk class.
+     *
+     * @constructor
+     * @param {SdkConfig} config - The configuration object for the SDK.
+     */
+    constructor(config: SdkConfig);
+}
+export default IntegrationSdk;

package/dist/sdk.d.ts

@@ -0,0 +1,211 @@
+import { ApiConfigs, SdkConfig } from "./types";
+import { AxiosInstance, AxiosResponse } from "axios";
+import AuthenticationApi from "./endpoints/auth";
+import MarketplaceApi from "./endpoints/marketplace";
+import Listings from "./endpoints/marketplace/Listings";
+import AvailabilityExceptions from "./endpoints/marketplace/AvailabilityExceptions";
+import Bookings from "./endpoints/marketplace/Bookings";
+import CurrentUser from "./endpoints/marketplace/CurrentUser";
+import Images from "./endpoints/marketplace/Images";
+import Marketplace from "./endpoints/marketplace/Marketplace";
+import Messages from "./endpoints/marketplace/Messages";
+import OwnListings from "./endpoints/marketplace/OwnListings";
+import PasswordReset from "./endpoints/marketplace/PasswordReset";
+import ProcessTransitions from "./endpoints/marketplace/ProcessTransitions";
+import Reviews from "./endpoints/marketplace/Reviews";
+import Stock from "./endpoints/marketplace/Stock";
+import StockAdjustments from "./endpoints/marketplace/StockAdjustments";
+import StripeAccount from "./endpoints/marketplace/StripeAccount";
+import StripeAccountLinks from "./endpoints/marketplace/StripeAccountLinks";
+import StripeCustomer from "./endpoints/marketplace/StripeCustomer";
+import StripePersons from "./endpoints/marketplace/StripePersons";
+import StripeSetupIntents from "./endpoints/marketplace/StripeSetupIntents";
+import TimeSlots from "./endpoints/marketplace/TimeSlots";
+import Transactions from "./endpoints/marketplace/Transactions";
+import Users from "./endpoints/marketplace/Users";
+import { AuthInfoResponse, LoginParameter, LoginWithIdpParameter, RevokeResponse, TokenResponse, TrustedUserTokenRequest, UserTokenRequest, UserTokenRequestWithAuthCode } from "./types";
+import AssetsApi from "./endpoints/assets";
+declare class SharetribeSdk {
+    /**
+     * The SDK configuration object.
+     * @type {SdkConfig}
+     */
+    sdkConfig: SdkConfig;
+    /**
+     * The API configuration object.
+     * @type {ApiConfigs}
+     */
+    apisConfigs: ApiConfigs;
+    /**
+     * Axios instance for making HTTP requests.
+     * @type {AxiosInstance}
+     */
+    axios: AxiosInstance;
+    /**
+     * Endpoint for handling authentication.
+     * @type {AuthenticationApi}
+     */
+    auth: AuthenticationApi;
+    /**
+     * Main marketplace API instance.
+     * @type {MarketplaceApi}
+     */
+    api: MarketplaceApi;
+    /**
+     * Assets API instance for managing assets.
+     * @type {AssetsApi}
+     */
+    assetsApi: AssetsApi;
+    /**
+     * Endpoint for managing listings.
+     * @type {Listings}
+     */
+    listings: Listings;
+    /**
+     * Endpoint for managing availability exceptions.
+     * @type {AvailabilityExceptions}
+     */
+    availabilityExceptions: AvailabilityExceptions;
+    /**
+     * Endpoint for managing bookings.
+     * @type {Bookings}
+     * */
+    bookings: Bookings;
+    /**
+     * Endpoint for managing the current user.
+     *  @type {CurrentUser}
+     */
+    currentUser: CurrentUser;
+    /**
+     * Endpoint for handling images.
+     * @type {Images}
+     */
+    images: Images;
+    /**
+     * Endpoint for accessing marketplace details.
+     *  @type {Marketplace}
+     */
+    marketplace: Marketplace;
+    /**
+     * Endpoint for managing messages.
+     * @type {Messages}
+     */
+    messages: Messages;
+    /**
+     * Endpoint for managing own listings.
+     * @type {OwnListings} */
+    ownListings: OwnListings;
+    /**
+     * Endpoint for managing password resets.
+     * @type {PasswordReset} */
+    passwordReset: PasswordReset;
+    /**
+     * Endpoint for managing process transitions.
+     * @type {ProcessTransitions} */
+    processTransitions: ProcessTransitions;
+    /**
+     * Endpoint for managing reviews.
+     *  @type {Reviews} */
+    reviews: Reviews;
+    /**
+     * Endpoint for managing stock.
+     * @type {Stock} */
+    stock: Stock;
+    /**
+     * Endpoint for managing stock adjustments.
+     * @type {StockAdjustments} */
+    stockAdjustments: StockAdjustments;
+    /**
+     * Endpoint for managing stripe accounts.
+     * @type {StripeAccount} */
+    stripeAccount: StripeAccount;
+    /**
+     * Endpoint for managing stripe account links.
+     * @type {StripeAccountLinks} */
+    stripeAccountLinks: StripeAccountLinks;
+    /**
+     * Endpoint for managing stripe customers.
+     * @type {StripeCustomer} */
+    stripeCustomer: StripeCustomer;
+    /**
+     * Endpoint for managing stripe persons.
+     * @type {StripePersons} */
+    stripePersons: StripePersons;
+    /**
+     * Endpoint for managing stripe setup intents.
+     * @type {StripeSetupIntents} */
+    stripeSetupIntents: StripeSetupIntents;
+    /**
+     * Endpoint for managing timeslots.
+     * @type {TimeSlots} */
+    timeslots: TimeSlots;
+    /**
+     * Endpoint for managing transactions.
+     * @type {Transactions} */
+    transactions: Transactions;
+    /**
+     * Endpoint for managing users.
+     * @type {Users} */
+    users: Users;
+    /** @type {AssetsApi['assetByAlias']} */
+    assetByAlias: AssetsApi["assetByAlias"];
+    /** @type {AssetsApi['assetsByAlias']} */
+    assetsByAlias: AssetsApi["assetsByAlias"];
+    /** @type {AssetsApi['assetByVersion']} */
+    assetByVersion: AssetsApi["assetByVersion"];
+    /** @type {AssetsApi['assetsByVersion']} */
+    assetsByVersion: AssetsApi["assetsByVersion"];
+    /**
+     * Creates an instance of the Sharetribe SDK.
+     *
+     * @constructor
+     * @param {SdkConfig} config - The configuration object for the SDK.
+     */
+    constructor(config: SdkConfig);
+    /**
+     * Logs in a user using their credentials.
+     *
+     * @async
+     * @param {LoginParameter} params - The login parameters.
+     * @returns {Promise<AuthToken>} - The authentication token.
+     */
+    login(params: LoginParameter<'user'>): Promise<AxiosResponse<TokenResponse<UserTokenRequest>>>;
+    /**
+     * Logs in the marketplace operator as the marketplace user and returns a Promise
+     *
+     * @async
+     * @param {LoginParameter} params - The login parameters.
+     * @returns {Promise<AuthToken>} - The authentication token.
+     */
+    loginAs(params: LoginParameter<'auth_code'>): Promise<AxiosResponse<TokenResponse<UserTokenRequestWithAuthCode>>>;
+    /**
+     * Logs in a user using an identity provider (IDP).
+     *
+     * @async
+     * @param {LoginWithIdpParameter} params - The IDP login parameters.
+     * @returns {Promise<AuthToken>} - The authentication token.
+     */
+    loginWithIdp(params: LoginWithIdpParameter): Promise<AxiosResponse<TokenResponse<UserTokenRequest>>>;
+    /**
+     * Logs out the current user.
+     *
+     * @async
+     * @returns {Promise<void>} - Resolves when the user is logged out.
+     */
+    logout(): Promise<AxiosResponse<RevokeResponse>>;
+    /**
+     * Exchanges the current token for a trusted user token.
+     *
+     * @async
+     * @returns {Promise<AuthToken>} - The exchanged token.
+     */
+    exchangeToken(): Promise<AxiosResponse<TokenResponse<TrustedUserTokenRequest>>>;
+    /**
+     * Retrieves authentication info for the current user.
+     *
+     * @async
+     * @returns {Promise<AuthInfoResponse>} - The authentication info.
+     */
+    authInfo(): Promise<AuthInfoResponse>;
+}
+export default SharetribeSdk;

package/dist/sdkTypes/BigDecimal.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Class representing a high-precision decimal number.
+ *
+ * The BigDecimal class ensures that large decimal numbers are stored as strings
+ * to avoid precision loss during computations.
+ */
+import { SdkType } from "../types";
+declare const BIGDECIMAL_SDK_TYPE = "BigDecimal";
+declare class BigDecimal implements SdkType {
+    value: string;
+    readonly _sdkType: typeof BIGDECIMAL_SDK_TYPE;
+    /**
+     * Creates an instance of the BigDecimal class.
+     *
+     * @param {any} value - The value to be stored as a BigDecimal. It must be convertible to a string.
+     * @example
+     * const bigDecimal = new BigDecimal('123456789.123456789');
+     */
+    constructor(value: any);
+    /**
+     * Converts the BigDecimal instance to a string representation.
+     *
+     * @returns {string} - The string representation of the BigDecimal.
+     * @example
+     * const bigDecimal = new BigDecimal('123456789.123456789');
+     * console.log(bigDecimal.toString()); // Outputs: '123456789.123456789'
+     */
+    toString(): string;
+}
+export default BigDecimal;

package/dist/sdkTypes/LatLng.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @fileoverview Provides the LatLng class for representing geographical coordinates.
+ * This class encapsulates a latitude and longitude pair, with validation for numeric input.
+ */
+import { SdkType } from "../types";
+declare const LATLNG_SDK_TYPE = "LatLng";
+/**
+ * Class representing a geographical coordinate pair (latitude and longitude).
+ */
+declare class LatLng implements SdkType {
+    lat: number | string;
+    lng: number | string;
+    readonly _sdkType: typeof LATLNG_SDK_TYPE;
+    /**
+     * Creates an instance of the LatLng class.
+     *
+     * @param {string | number} lat - The latitude value. Must be a number or a string that represents a number.
+     * @param {string | number} lng - The longitude value. Must be a number or a string that represents a number.
+     * @example
+     * const coordinates = new LatLng(37.7749, -122.4194);
+     * console.log(coordinates.toString()); // Outputs: '37.7749,-122.4194'
+     */
+    constructor(lat: string | number, lng: string | number);
+    /**
+     * Converts the LatLng instance to a string representation.
+     *
+     * @returns {string} - A string in the format "latitude,longitude".
+     * @example
+     * const coordinates = new LatLng(37.7749, -122.4194);
+     * console.log(coordinates.toString()); // Outputs: '37.7749,-122.4194'
+     */
+    toString(): string;
+}
+export default LatLng;

package/dist/sdkTypes/LatLngBounds.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @fileoverview Provides the LatLngBounds class for representing geographical bounding boxes.
+ * This class encapsulates a northeast (NE) and southwest (SW) pair of coordinates to define a rectangular area.
+ */
+import LatLng from "./LatLng";
+import { SdkType } from "../types";
+declare const LATLNGBOUNDS_SDK_TYPE = "LatLngBounds";
+/**
+ * Class representing a geographical bounding box with NE and SW coordinates.
+ */
+declare class LatLngBounds implements SdkType {
+    ne: LatLng | {
+        lat: number | string;
+        lng: number | string;
+    };
+    sw: LatLng | {
+        lat: number | string;
+        lng: number | string;
+    };
+    readonly _sdkType: typeof LATLNGBOUNDS_SDK_TYPE;
+    /**
+     * Creates an instance of the LatLngBounds class.
+     *
+     * @param {LatLng | { lat: number; lng: number }} ne - The northeast coordinate.
+     * @param {LatLng | { lat: number; lng: number }} sw - The southwest coordinate.
+     * @example
+     * const ne = new LatLng(40.7128, -74.0060);
+     * const sw = new LatLng(34.0522, -118.2437);
+     * const bounds = new LatLngBounds(ne, sw);
+     * console.log(bounds.toString()); // Outputs: '40.7128,-74.0060,34.0522,-118.2437'
+     */
+    constructor(ne: LatLng | {
+        lat: number;
+        lng: number;
+    }, sw: LatLng | {
+        lat: number;
+        lng: number;
+    });
+    /**
+     * Converts the LatLngBounds instance to a string representation.
+     *
+     * @returns {string} - A string in the format "NE_lat,NE_lng,SW_lat,SW_lng".
+     * @example
+     * const ne = new LatLng(40.7128, -74.0060);
+     * const sw = new LatLng(34.0522, -118.2437);
+     * const bounds = new LatLngBounds(ne, sw);
+     * console.log(bounds.toString()); // Outputs: '40.7128,-74.0060,34.0522,-118.2437'
+     */
+    toString(): string;
+}
+export default LatLngBounds;

package/dist/sdkTypes/Money.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @fileoverview Provides the Money class for handling monetary values.
+ * This class ensures proper structure and validation of monetary values with an amount and a currency.
+ */
+import { SdkType } from "../types";
+declare const MONEY_SDK_TYPE = "Money";
+/**
+ * Class representing a monetary value.
+ *
+ * The Money class encapsulates an amount in the smallest unit of the currency (e.g., cents)
+ * and a currency code (e.g., "USD").
+ */
+declare class Money implements SdkType {
+    amount: number;
+    currency: string;
+    readonly _sdkType: typeof MONEY_SDK_TYPE;
+    /**
+     * Creates an instance of the Money class.
+     *
+     * @param {number} amount - The monetary amount, represented in the smallest unit of the currency (e.g., cents for USD).
+     * @param {string} currency - The currency code, represented as a three-character string (e.g., "USD").
+     * @example
+     * const money = new Money(1000, 'USD');
+     * console.log(money); // Outputs: Money { amount: 1000, currency: 'USD' }
+     */
+    constructor(amount: number, currency: string);
+}
+export default Money;

package/dist/sdkTypes/UUID.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview Provides the UUID class for handling universally unique identifiers (UUIDs).
+ * This class allows for the creation and validation of UUIDs, using the `uuid` library.
+ */
+import { SdkType } from "../types";
+declare const UUID_SDK_TYPE = "UUID";
+/**
+ * Class representing a UUID (Universally Unique Identifier).
+ *
+ * The UUID class ensures that a valid UUID is created or used, with the option to generate one if none is provided.
+ */
+declare class UUID implements SdkType {
+    uuid: string;
+    readonly _sdkType: typeof UUID_SDK_TYPE;
+    /**
+     * Creates an instance of the UUID class.
+     *
+     * @param {string} [uuid] - An optional UUID string. If not provided, a new UUID will be generated.
+     * @example
+     * const id = new UUID();
+     * console.log(id.toString()); // Outputs a newly generated UUID.
+     *
+     * const predefinedId = new UUID('123e4567-e89b-12d3-a456-426614174000');
+     * console.log(predefinedId.toString()); // Outputs: '123e4567-e89b-12d3-a456-426614174000'
+     */
+    constructor(uuid?: string);
+    /**
+     * Converts the UUID instance to its string representation.
+     *
+     * @returns {string} - The string representation of the UUID.
+     * @example
+     * const id = new UUID();
+     * console.log(id.toString()); // Outputs the UUID as a string.
+     */
+    toString(): string;
+}
+export default UUID;
+export type UUIDInstance = InstanceType<typeof UUID>;

package/dist/types/apiConfigs.d.ts

@@ -0,0 +1,104 @@
+/**
+ * @fileoverview Defines API configuration types for different environments and endpoints.
+ */
+import { SdkConfig } from "./config";
+/**
+ * Configuration type for various API endpoints.
+ *
+ * - When `I` is `false`, provides configurations for `api`, `auth`, and `assets` endpoints.
+ * - When `I` is `true`, provides configurations for the `integrationApi` endpoint.
+ */
+export type ApiConfigs<I extends boolean = false> = I extends false ? {
+    /**
+     * Configuration for the main API.
+     */
+    api: (config: SdkConfig) => {
+        headers: {
+            /**
+             * Optional header to enable verbose transit responses.
+             */
+            "X-Transit-Verbose"?: "true" | "false";
+            /**
+             * Header indicating the format for API responses.
+             */
+            Accept: "application/transit+json";
+        };
+        /**
+         * Base URL for the main API.
+         */
+        baseUrl: string;
+    };
+    /**
+     * Configuration for the authentication API.
+     */
+    auth: (config: SdkConfig) => {
+        headers: {
+            /**
+             * Header indicating the content type for authentication requests.
+             */
+            "Content-Type": "application/x-www-form-urlencoded";
+            /**
+             * Header indicating the format for authentication API responses.
+             */
+            Accept: "application/json";
+        };
+        /**
+         * Base URL for the authentication API.
+         */
+        baseUrl: string;
+    };
+    /**
+     * Configuration for the assets API.
+     */
+    assets: (config: SdkConfig) => {
+        headers: {
+            /**
+             * Header indicating the format for assets API responses.
+             */
+            Accept: "application/json";
+        };
+        /**
+         * Base URL for the assets API.
+         */
+        baseUrl: string;
+    };
+} : {
+    /**
+     * Configuration for the authentication API.
+     */
+    auth: (config: SdkConfig) => {
+        headers: {
+            /**
+             * Header indicating the content type for authentication requests.
+             */
+            "Content-Type": "application/x-www-form-urlencoded";
+            /**
+             * Header indicating the format for authentication API responses.
+             */
+            Accept: "application/json";
+        };
+        /**
+         * Base URL for the authentication API.
+         */
+        baseUrl: string;
+    };
+    /**
+     * Configuration for the integration API.
+     */
+    integrationApi: (config: SdkConfig) => {
+        headers: {
+            /**
+             * Optional header to enable verbose transit responses.
+             */
+            "X-Transit-Verbose"?: "true" | "false";
+            /**
+             * Header indicating the format for integration API responses.
+             */
+            Accept: "application/transit+json";
+        };
+        /**
+         * Base URL for the integration API.
+         */
+        baseUrl: string;
+    };
+};