UNPKG

@vansite/ts-sharetribe-flex-sdk

Version:

This is a TypeScript SDK for Sharetribe Flex API. It reduces the complexity of the API and provides a more user-friendly interface.

120 lines (119 loc) 3.13 kB
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;