@vansite/ts-sharetribe-flex-sdk 1.0.0

package/dist/types/endpoints/assets/index.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @fileoverview Provides the AssetsApi class for interacting with the Sharetribe Asset Delivery API.
+ * This class includes methods to retrieve assets by alias or version.
+ *
+ * For more information, refer to the Asset Delivery API reference:
+ * https://www.sharetribe.com/api-reference/asset-delivery-api.html
+ */
+import SharetribeSdk from "../../sdk";
+import { AxiosInstance, AxiosResponse } from "axios";
+import { AssetByAliasParameter, AssetByVersionParameter, AssetResponse, AssetsByAliasParameter, AssetsByVersionParameter } from "../../types/assets";
+/**
+ * Class representing the Assets API for interacting with the Sharetribe Asset Delivery API.
+ */
+declare class AssetsApi {
+    axios: AxiosInstance;
+    endpoint: string;
+    headers: Record<string, string>;
+    /**
+     * Creates an instance of AssetsApi.
+     *
+     * @param {SharetribeSdk} sdk - The Sharetribe SDK instance for configuration and request handling.
+     */
+    constructor(sdk: SharetribeSdk);
+    /**
+     * Retrieves a single asset by alias.
+     *
+     * @template P
+     * @param {P & AssetByAliasParameter} params - Parameters including alias and path for the asset.
+     * @returns {Promise<AssetResponse<'assetByAlias', P>>} - A promise resolving to the asset response.
+     * @throws {Error} If the path starts with a leading slash.
+     */
+    assetByAlias<P extends AssetByAliasParameter>(params: P): Promise<AxiosResponse<AssetResponse<"assetByAlias", P>>>;
+    /**
+     * Retrieves multiple assets by alias.
+     *
+     * @template P
+     * @param {P & AssetsByAliasParameter} params - Parameters including alias and paths for the assets.
+     * @returns {Promise<AssetResponse<'assetsByAlias', P>>} - A promise resolving to the assets response.
+     * @throws {Error} If any path starts with a leading slash or if paths are empty.
+     */
+    assetsByAlias<P extends AssetsByAliasParameter>(params: P): Promise<AxiosResponse<AssetResponse<"assetsByAlias", P>>>;
+    /**
+     * Retrieves a single asset by version.
+     *
+     * @template P
+     * @param {P & AssetByVersionParameter} params - Parameters including version and path for the asset.
+     * @returns {Promise<AssetResponse<'assetByVersion', P>>} - A promise resolving to the asset response.
+     * @throws {Error} If the path starts with a leading slash.
+     */
+    assetByVersion<P extends AssetByVersionParameter>(params: P): Promise<AxiosResponse<AssetResponse<"assetByVersion", P>>>;
+    /**
+     * Retrieves multiple assets by version.
+     *
+     * @template P
+     * @param {P & AssetsByVersionParameter} params - Parameters including version and paths for the assets.
+     * @returns {Promise<AssetResponse<'assetsByVersion', P>>} - A promise resolving to the assets response.
+     * @throws {Error} If any path starts with a leading slash.
+     */
+    assetsByVersion<P extends AssetsByVersionParameter>(params: P): Promise<AxiosResponse<AssetResponse<"assetsByVersion", P>>>;
+}
+export default AssetsApi;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/endpoints/assets/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/assets/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,aAAa,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,aAAa,EACb,sBAAsB,EACtB,wBAAwB,EACzB,MAAM,oBAAoB,CAAC;AAyB5B;;GAEG;AACH,cAAM,SAAS;IACb,KAAK,EAAE,aAAa,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC;;;;OAIG;gBACS,GAAG,EAAE,aAAa;IAO9B;;;;;;;OAOG;IACG,YAAY,CAAC,CAAC,SAAS,qBAAqB,EAChD,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC;IAY3D;;;;;;;OAOG;IACG,aAAa,CAAC,CAAC,SAAS,sBAAsB,EAClD,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;IAmB5D;;;;;;;OAOG;IACG,cAAc,CAAC,CAAC,SAAS,uBAAuB,EACpD,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,CAAC;IAY7D;;;;;;;OAOG;IACG,eAAe,CAAC,CAAC,SAAS,wBAAwB,EACtD,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,CAAC;CAe/D;AAED,eAAe,SAAS,CAAC"}

package/dist/types/endpoints/auth/index.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @fileoverview Provides the AuthenticationApi class for interacting with the Sharetribe Authentication API.
+ * This class includes methods to obtain and manage access tokens for authenticating requests to the Marketplace API and Integration API.
+ *
+ * For more information, refer to the Authentication API reference:
+ * https://www.sharetribe.com/api-reference/authentication.html
+ */
+import { AuthWithIdpParameter, Endpoint, RevokeResponse, ScopeType, TokenResponse } from "../../types/authentication";
+import { AxiosResponse } from "axios";
+import SharetribeSdk from "../../sdk";
+import IntegrationSdk from "../../integrationSdk";
+/**
+ * Class representing the Authentication API for obtaining and managing access tokens.
+ *
+ * The Authentication API follows the OAuth2 framework and supports various grant types to issue tokens for authenticating requests.
+ *
+ * @see https://www.sharetribe.com/api-reference/authentication.html
+ */
+declare class AuthenticationApi {
+    private readonly endpoint;
+    private readonly headers;
+    private axios;
+    /**
+     * Creates an instance of AuthenticationApi.
+     *
+     * @param {SharetribeSdk | IntegrationSdk} sdk - The Sharetribe SDK or Integration SDK instance for configuration and request handling.
+     */
+    constructor(sdk: SharetribeSdk | IntegrationSdk);
+    /**
+     * Obtains an access token using the specified grant type and parameters.
+     *
+     * @template S
+     * @param {Endpoint<S>} params - Parameters including grant type and necessary credentials.
+     * @returns {Promise<TokenResponse<S>>} - A promise resolving to the token response.
+     */
+    token<S extends ScopeType>(params: Endpoint<S>): Promise<AxiosResponse<TokenResponse<S>>>;
+    /**
+     * Authenticates a user using an external identity provider (IdP) and obtains an access token.
+     *
+     * @param {AuthWithIdpParameter} params - Parameters including IdP token and provider details.
+     * @returns {Promise<TokenResponse<'user'>>} - A promise resolving to the token response.
+     */
+    authWithIdp<P extends AuthWithIdpParameter>(params: P): Promise<AxiosResponse<TokenResponse<"user">>>;
+    /**
+     * Revokes a refresh token, effectively invalidating any associated access tokens.
+     *
+     * @param {string} token - The refresh token to be revoked.
+     * @returns {Promise<RevokeResponse>} - A promise resolving to the revoke response.
+     */
+    revoke(token: string): Promise<AxiosResponse<RevokeResponse>>;
+    /**
+     * Retrieves details about the current access token.
+     *
+     * @returns {Promise<TokenResponse<'details'>>} - A promise resolving to the token details response.
+     */
+    details(): Promise<AxiosResponse<TokenResponse<"details">>>;
+}
+export default AuthenticationApi;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/endpoints/auth/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/auth/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACL,oBAAoB,EACpB,QAAQ,EACR,cAAc,EACd,SAAS,EACT,aAAa,EACd,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,aAAa,MAAM,WAAW,CAAC;AACtC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AA2BlD;;;;;;GAMG;AACH,cAAM,iBAAiB;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;IACjD,OAAO,CAAC,KAAK,CAAgB;IAE7B;;;;OAIG;gBACS,GAAG,EAAE,aAAa,GAAG,cAAc;IAO/C;;;;;;OAMG;IACG,KAAK,CAAC,CAAC,SAAS,SAAS,EAC7B,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,GAClB,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAQ3C;;;;;OAKG;IACG,WAAW,CAAC,CAAC,SAAS,oBAAoB,EAC9C,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAQhD;;;;;OAKG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAQnE;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;CAMlE;AAED,eAAe,iBAAiB,CAAC"}

package/dist/types/endpoints/integrationApi/AvailabilityExceptions.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @fileoverview Provides the AvailabilityExceptions class for managing availability exceptions in the Sharetribe Integration API.
+ * This class allows querying, creating, and deleting availability exceptions for resources in a Sharetribe marketplace.
+ *
+ * For more details, refer to the Integration API documentation:
+ * https://www.sharetribe.com/api-reference/integration.html#availability-exceptions
+ */
+import { AxiosResponse } from "axios";
+import IntegrationApi from "./index";
+import { AvailabilityExceptionsCreateParameter, AvailabilityExceptionsDeleteParameter, AvailabilityExceptionsQueryParameter, AvailabilityExceptionsResponse } from "../../types/marketplace/availabilityExceptions";
+import { ExtraParameter } from "../../types/sharetribe";
+/**
+ * Class representing the Availability Exceptions API.
+ *
+ * Availability exceptions are used to override default availability rules for specific time ranges.
+ * This class provides methods to query, create, and delete such exceptions.
+ */
+declare class AvailabilityExceptions {
+    private readonly endpoint;
+    private readonly axios;
+    private readonly headers;
+    readonly authRequired = true;
+    /**
+     * Creates an instance of the AvailabilityExceptions class.
+     *
+     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
+     */
+    constructor(api: IntegrationApi);
+    /**
+     * Queries availability exceptions for a resource.
+     *
+     * @template P
+     * @param {P & AvailabilityExceptionsQueryParameter} params - Query parameters to filter availability exceptions.
+     * @returns {Promise<AvailabilityExceptionsResponse<'query', P>>} - A promise resolving to the query response.
+     *
+     * @example
+     * const response = await integrationSdk.availabilityExceptions.query({
+     *   listingId: 'listing-id',
+     *   start: '2024-12-01T00:00:00Z',
+     *   end: '2024-12-31T23:59:59Z'
+     * });
+     *
+     * // Access the list of exceptions
+     * const exceptions = response.data;
+     */
+    query<P extends AvailabilityExceptionsQueryParameter>(params: P): Promise<AxiosResponse<AvailabilityExceptionsResponse<"query", P>>>;
+    /**
+     * Creates a new availability exception for a resource.
+     *
+     * @template P
+     * @template EP
+     * @param {P & AvailabilityExceptionsCreateParameter} params - Parameters to define the availability exception.
+     * @param {EP | void} [extraParams] - Optional additional parameters.
+     * @returns {Promise<AvailabilityExceptionsResponse<'create', P, EP>>} - A promise resolving to the create response.
+     *
+     * @example
+     * const response = await integrationSdk.availabilityExceptions.create({
+     *   listingId: 'listing-id',
+     *   start: '2024-12-10T10:00:00Z',
+     *   end: '2024-12-10T12:00:00Z',
+     *   seats: 0
+     * });
+     *
+     * // Access the created exception
+     * const createdException = response.data;
+     */
+    create<P extends AvailabilityExceptionsCreateParameter, EP extends ExtraParameter>(params: P, extraParams: EP | void): Promise<AxiosResponse<AvailabilityExceptionsResponse<"create", P, EP>>>;
+    /**
+     * Deletes an availability exception for a resource.
+     *
+     * @template P
+     * @param {P & AvailabilityExceptionsDeleteParameter} params - Parameters to specify the exception to delete.
+     * @returns {Promise<AvailabilityExceptionsResponse<'delete', P>>} - A promise resolving to the delete response.
+     *
+     * @example
+     * const response = await integrationSdk.availabilityExceptions.delete({
+     *   id: 'exception-id'
+     * });
+     *
+     * // Check the deletion result
+     * const result = response.data;
+     */
+    delete<P extends AvailabilityExceptionsDeleteParameter>(params: P): Promise<AxiosResponse<AvailabilityExceptionsResponse<"delete", P>>>;
+}
+export default AvailabilityExceptions;
+//# sourceMappingURL=AvailabilityExceptions.d.ts.map

package/dist/types/endpoints/integrationApi/AvailabilityExceptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AvailabilityExceptions.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/integrationApi/AvailabilityExceptions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,qCAAqC,EACrC,qCAAqC,EACrC,oCAAoC,EACpC,8BAA8B,EAC/B,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;;GAKG;AACH,cAAM,sBAAsB;IAC1B,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;;;;;;;;;;;;;;;;OAgBG;IACG,KAAK,CAAC,CAAC,SAAS,oCAAoC,EACxD,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,8BAA8B,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAUrE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CACV,CAAC,SAAS,qCAAqC,EAC/C,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,EAAE,EAAE,GAAG,IAAI,GACrB,OAAO,CAAC,aAAa,CAAC,8BAA8B,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAQ1E;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,CAAC,SAAS,qCAAqC,EAC1D,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,8BAA8B,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;CAOvE;AAED,eAAe,sBAAsB,CAAC"}

package/dist/types/endpoints/integrationApi/Events.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @fileoverview Provides the Events class for querying event data in the Sharetribe Integration API.
+ * This class allows querying events related to bookings or other entities in a Sharetribe marketplace.
+ *
+ * For more details, refer to the Integration API documentation:
+ * https://www.sharetribe.com/api-reference/integration.html#events
+ */
+import { AxiosResponse } from "axios";
+import IntegrationApi from "./index";
+import { EventQueryParameter, EventsResponse } from "../../types/integration/events";
+/**
+ * Class representing the Events API.
+ *
+ * The Events API provides access to event data, such as booking events, allowing integration with external systems.
+ */
+declare class Events {
+    private readonly endpoint;
+    private readonly axios;
+    private readonly headers;
+    /**
+     * Creates an instance of the Events class.
+     *
+     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
+     */
+    constructor(api: IntegrationApi);
+    /**
+     * Queries event data based on the specified parameters.
+     *
+     * @template P
+     * @param {P & EventQueryParameter} params - Query parameters to filter events.
+     * @returns {Promise<EventsResponse<'query'>>} - A promise resolving to the event query response.
+     *
+     * @example
+     * const response = await integrationSdk.events.query({
+     *  startAfterSequenceId: 'event-sequence-id',
+     *  createdAtStart: '2021-01-01T00:00:00Z',
+     *  resourceId: 'resource-id',
+     *  relatedResourceId: 'related-resource-id',
+     *  eventTypes: ['eventType1', 'eventType2'],
+     * });
+     *
+     * // Access the list of events
+     * const eventsList = response.data;
+     */
+    query<P extends EventQueryParameter>(params: P): Promise<AxiosResponse<EventsResponse<"query">>>;
+}
+export default Events;
+//# sourceMappingURL=Events.d.ts.map

package/dist/types/endpoints/integrationApi/Events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Events.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/integrationApi/Events.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,mBAAmB,EACnB,cAAc,EACf,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,cAAM,MAAM;IACV,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;;;;;;;;;;;;;;;;;;OAkBG;IACG,KAAK,CAAC,CAAC,SAAS,mBAAmB,EACvC,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;CAMnD;AAED,eAAe,MAAM,CAAC"}

package/dist/types/endpoints/integrationApi/Images.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @fileoverview Provides the Images class for handling image uploads in the Sharetribe Integration API.
+ * This class allows uploading images to be used as resources in a Sharetribe marketplace.
+ *
+ * For more details, refer to the Integration API documentation:
+ * https://www.sharetribe.com/api-reference/integration.html#images
+ */
+import { AxiosResponse } from "axios";
+import IntegrationApi from "./index";
+import { ImagesResponse, ImagesUploadParameter } from "../../types/marketplace/images";
+import { ExtraParameter } from "../../types/sharetribe";
+/**
+ * Class representing the Images API.
+ *
+ * The Images API allows uploading images to the marketplace for use in listings or other resources.
+ */
+declare class Images {
+    private readonly endpoint;
+    private readonly axios;
+    private readonly headers;
+    readonly authRequired = true;
+    /**
+     * Creates an instance of the Images class.
+     *
+     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
+     */
+    constructor(api: IntegrationApi);
+    /**
+     * Uploads an image to the marketplace.
+     *
+     * @template P
+     * @template EP
+     * @param {P & ImagesUploadParameter} params - The image upload parameters, including image data and related metadata.
+     * @param {EP & ExtraParameter} extraParams - Optional additional parameters for the upload request.
+     * @returns {Promise<ImagesResponse<'upload', EP>>} - A promise resolving to the upload response.
+     *
+     * @example
+     * const response = await integrationSdk.images.upload({
+     *   image: fileData,
+     * });
+     *
+     * // Access the uploaded image details
+     * const imageDetails = response.data;
+     */
+    upload<P extends ImagesUploadParameter, EP extends ExtraParameter>(params: P, extraParams: EP): Promise<AxiosResponse<ImagesResponse<"upload", EP>>>;
+}
+export default Images;
+//# sourceMappingURL=Images.d.ts.map

package/dist/types/endpoints/integrationApi/Images.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Images.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/integrationApi/Images.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,cAAc,EACd,qBAAqB,EACtB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,MAAM;IACV,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;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CAAC,CAAC,SAAS,qBAAqB,EAAE,EAAE,SAAS,cAAc,EACrE,MAAM,EAAE,CAAC,EACT,WAAW,EAAE,EAAE,GACd,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC;CAOxD;AAED,eAAe,MAAM,CAAC"}

package/dist/types/endpoints/integrationApi/Listings.d.ts

@@ -0,0 +1,150 @@
+/**
+ * @fileoverview Provides the Listings class for managing listings in the Sharetribe Integration API.
+ * This class allows creating, updating, querying, and performing other operations on marketplace listings.
+ *
+ * For more details, refer to the Integration API documentation:
+ * https://www.sharetribe.com/api-reference/integration.html#listings
+ */
+import { AxiosResponse } from "axios";
+import IntegrationApi from "./index";
+import { ListingsApproveParameter, ListingsCloseParameter, ListingsCreateParameter, ListingsOpenParameter, ListingsQueryParameter, ListingsResponse, ListingsShowParameter, ListingsUpdateParameter } from "../../types/marketplace/listings";
+import { ExtraParameter } from "../../types/sharetribe";
+/**
+ * Class representing the Listings API.
+ *
+ * The Listings API provides methods to manage marketplace listings, such as creating, updating, querying, and approving listings.
+ */
+declare class Listings {
+    private readonly endpoint;
+    private readonly axios;
+    private readonly headers;
+    /**
+     * Creates an instance of the Listings class.
+     *
+     * @param {IntegrationApi} api - The Marketplace API instance providing configuration and request handling.
+     */
+    constructor(api: IntegrationApi);
+    /**
+     * Retrieves details of a specific listing.
+     *
+     * @template P
+     * @param {P & ListingsShowParameter} params - The parameters to identify the listing.
+     * @returns {Promise<ListingsResponse<'show', P>>} - A promise resolving to the listing details.
+     *
+     * @example
+     * const response = await integrationSdk.listings.show({
+     *   id: 'listing-id'
+     * });
+     *
+     * const listing = response.data;
+     */
+    show<P extends ListingsShowParameter>(params: P): Promise<AxiosResponse<ListingsResponse<"show", P, undefined, true>>>;
+    /**
+     * Queries listings based on specified filters.
+     *
+     * @template P
+     * @param {P & ListingsQueryParameter} params - Query parameters to filter listings.
+     * @returns {Promise<ListingsResponse<'query', P>>} - A promise resolving to the query results.
+     *
+     * @example
+     * const response = await integrationSdk.listings.query({
+     *   ids: ['listing-id-1', 'listing-id-2'],
+     *   per_page: 10,
+     *   page: 1
+     * });
+     *
+     * const listings = response.data;
+     */
+    query<P extends ListingsQueryParameter>(params: P): Promise<AxiosResponse<ListingsResponse<"query", P, undefined, false>>>;
+    /**
+     * Creates a new listing.
+     *
+     * @template P
+     * @template EP
+     * @param {P & ListingsCreateParameter} params - Parameters for the new listing.
+     * @param {EP | void} extraParams - Optional extra parameters for the request.
+     * @returns {Promise<ListingsResponse<'create', P, EP, true>>} - A promise resolving to the created listing.
+     *
+     * @example
+     * const response = await integrationSdk.listings.create({
+     *   title: 'New Listing',
+     *   description: 'Description of the listing',
+     *   authorId: 'user-id',
+     *   state: 'published'
+     * });
+     *
+     * const newListing = response.data;
+     */
+    create<P extends ListingsCreateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<ListingsResponse<"create", P, EP, true>>>;
+    /**
+     * Updates an existing listing.
+     *
+     * @template P
+     * @template EP
+     * @param {P & ListingsUpdateParameter} params - Parameters for the listing update.
+     * @param {EP | void} extraParams - Optional extra parameters for the request.
+     * @returns {Promise<ListingsResponse<'update', P, EP>>} - A promise resolving to the updated listing.
+     *
+     * @example
+     * const response = await integrationSdk.listings.update({
+     *   id: 'listing-id',
+     *   title: 'Updated Title'
+     * });
+     *
+     * const updatedListing = response.data;
+     */
+    update<P extends ListingsUpdateParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<ListingsResponse<"update", P, EP, true>>>;
+    /**
+     * Closes a listing.
+     *
+     * @template P
+     * @template EP
+     * @param {P & ListingsCloseParameter} params - Parameters to identify the listing to close.
+     * @param {EP | void} extraParams - Optional extra parameters for the request.
+     * @returns {Promise<ListingsResponse<'close', P, EP>>} - A promise resolving to the closed listing.
+     *
+     * @example
+     * const response = await integrationSdk.listings.close({
+     *   id: 'listing-id'
+     * });
+     *
+     * const closedListing = response.data;
+     */
+    close<P extends ListingsCloseParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<ListingsResponse<"close", P, EP, true>>>;
+    /**
+     * Opens a listing.
+     *
+     * @template P
+     * @template EP
+     * @param {P & ListingsOpenParameter} params - Parameters to identify the listing to open.
+     * @param {EP | void} extraParams - Optional extra parameters for the request.
+     * @returns {Promise<ListingsResponse<'open', P, EP>>} - A promise resolving to the opened listing.
+     *
+     * @example
+     * const response = await integrationSdk.listings.open({
+     *   id: 'listing-id'
+     * });
+     *
+     * const openedListing = response.data;
+     */
+    open<P extends ListingsOpenParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<ListingsResponse<"open", P, EP, true>>>;
+    /**
+     * Approves a listing.
+     *
+     * @template P
+     * @template EP
+     * @param {P & ListingsApproveParameter} params - Parameters to identify the listing to approve.
+     * @param {EP | void} extraParams - Optional extra parameters for the request.
+     * @returns {Promise<ListingsResponse<'approve', P, EP>>} - A promise resolving to the approved listing.
+     *
+     * @example
+     * const response = await integrationSdk.listings.approve({
+     *   id: 'listing-id'
+     * });
+     *
+     * const approvedListing = response.data;
+     */
+    approve<P extends ListingsApproveParameter, EP extends ExtraParameter>(params: P, extraParams?: EP): Promise<AxiosResponse<ListingsResponse<"approve", P, EP, true>>>;
+}
+export default Listings;
+//# sourceMappingURL=Listings.d.ts.map

package/dist/types/endpoints/integrationApi/Listings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Listings.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/integrationApi/Listings.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,wBAAwB,EACxB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,gBAAgB,EAChB,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,QAAQ;IACZ,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;;;;;;;;;;;;;OAaG;IACG,IAAI,CAAC,CAAC,SAAS,qBAAqB,EACxC,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAUvE;;;;;;;;;;;;;;;OAeG;IACG,KAAK,CAAC,CAAC,SAAS,sBAAsB,EAC1C,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;IAUzE;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,EAAE,SAAS,cAAc,EACvE,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IAQlE;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CAAC,CAAC,SAAS,uBAAuB,EAAE,EAAE,SAAS,cAAc,EACvE,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IAQlE;;;;;;;;;;;;;;;OAeG;IACG,KAAK,CAAC,CAAC,SAAS,sBAAsB,EAAE,EAAE,SAAS,cAAc,EACrE,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IAQjE;;;;;;;;;;;;;;;OAeG;IACG,IAAI,CAAC,CAAC,SAAS,qBAAqB,EAAE,EAAE,SAAS,cAAc,EACnE,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IAQhE;;;;;;;;;;;;;;;OAeG;IACG,OAAO,CAAC,CAAC,SAAS,wBAAwB,EAAE,EAAE,SAAS,cAAc,EACzE,MAAM,EAAE,CAAC,EACT,WAAW,CAAC,EAAE,EAAE,GACf,OAAO,CAAC,aAAa,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;CAOpE;AAED,eAAe,QAAQ,CAAC"}

package/dist/types/endpoints/integrationApi/Marketplace.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @fileoverview Provides the Marketplace class for interacting with the Sharetribe Integration API.
+ * This class allows fetching details about the marketplace configuration.
+ *
+ * For more details, refer to the Integration API documentation:
+ * https://www.sharetribe.com/api-reference/integration.html#marketplace
+ */
+import { AxiosResponse } from "axios";
+import IntegrationApi from "./index";
+import { MarketplaceResponse } from "../../types/marketplace/marketplace";
+/**
+ * Class representing the Marketplace API.
+ *
+ * The Marketplace API provides methods to retrieve marketplace configuration details.
+ */
+declare class Marketplace {
+    private readonly endpoint;
+    private readonly axios;
+    private readonly headers;
+    /**
+     * Creates an instance of the Marketplace class.
+     *
+     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
+     */
+    constructor(api: IntegrationApi);
+    /**
+     * Retrieves details about the marketplace configuration.
+     *
+     * @returns {Promise<AxiosResponse<MarketplaceResponse<'show'>>>} - A promise resolving to the marketplace details.
+     *
+     * @example
+     * const response = await integrationSdk.marketplace.show();
+     *
+     * const marketplaceDetails = response.data;
+     */
+    show(): Promise<AxiosResponse<MarketplaceResponse<"show">>>;
+}
+export default Marketplace;
+//# sourceMappingURL=Marketplace.d.ts.map

package/dist/types/endpoints/integrationApi/Marketplace.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Marketplace.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/integrationApi/Marketplace.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAE1E;;;;GAIG;AACH,cAAM,WAAW;IACf,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;;;;;;;;;OASG;IACG,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;CAQlE;AAED,eAAe,WAAW,CAAC"}

package/dist/types/endpoints/integrationApi/Stock.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @fileoverview Provides the Stock class for managing stock levels in the Sharetribe Integration API.
+ * This class allows performing operations on stock, such as compare-and-set updates.
+ *
+ * For more details, refer to the Integration API documentation:
+ * https://www.sharetribe.com/api-reference/integration.html#stock
+ */
+import { AxiosResponse } from "axios";
+import IntegrationApi from "./index";
+import { StockCompareAndSetParameter, StockResponse } from "../../types/marketplace/stock";
+import { ExtraParameter } from "../../types/sharetribe";
+/**
+ * Class representing the Stock API.
+ *
+ * The Stock API provides methods to manage stock levels for marketplace resources.
+ */
+declare class Stock {
+    private readonly endpoint;
+    private readonly axios;
+    readonly authRequired = true;
+    /**
+     * Creates an instance of the Stock class.
+     *
+     * @param {MarketplaceApi} api - The Marketplace API instance providing configuration and request handling.
+     */
+    constructor(api: IntegrationApi);
+    /**
+     * Updates stock levels using a compare-and-set operation.
+     *
+     * @template P
+     * @template EP
+     * @param {P & StockCompareAndSetParameter} params - Parameters specifying the stock to compare and set.
+     * @param {EP & ExtraParameter} extraParams - Optional additional parameters for the request.
+     * @returns {Promise<AxiosResponse<StockResponse<'compareAndSet', EP>>>} - A promise resolving to the stock update response.
+     *
+     * @example
+     * const response = await integrationSdk.stock.compareAndSet({
+     *   listingId: 'listing-id',
+     *   oldTotal: 5,
+     *   newTotal: 10,
+     * });
+     *
+     * const updatedStock = response.data;
+     */
+    compareAndSet<P extends StockCompareAndSetParameter, EP extends ExtraParameter>(params: P, extraParams: EP): Promise<AxiosResponse<StockResponse<"compareAndSet", EP>>>;
+}
+export default Stock;
+//# sourceMappingURL=Stock.d.ts.map

package/dist/types/endpoints/integrationApi/Stock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Stock.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/integrationApi/Stock.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,2BAA2B,EAC3B,aAAa,EACd,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,KAAK;IACT,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;;;;;;;;;;;;;;;;;OAiBG;IACG,aAAa,CACjB,CAAC,SAAS,2BAA2B,EACrC,EAAE,SAAS,cAAc,EAEzB,MAAM,EAAE,CAAC,EACT,WAAW,EAAE,EAAE,GACd,OAAO,CAAC,aAAa,CAAC,aAAa,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC,CAAC;CAM9D;AAED,eAAe,KAAK,CAAC"}

package/dist/types/endpoints/integrationApi/StockAdjustments.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @fileoverview Provides the StockAdjustments class for managing stock adjustments in the Sharetribe Integration API.
+ * This class allows querying and creating stock adjustment records.
+ *
+ * For more details, refer to the Integration API documentation:
+ * https://www.sharetribe.com/api-reference/integration.html#stock-adjustments
+ */
+import { AxiosResponse } from "axios";
+import IntegrationApi from "./index";
+import { StockAdjustmentsCreateParameter, StockAdjustmentsQueryParameter, StockAdjustmentsResponse } from "../../types/marketplace/stockAdjustment";
+import { ExtraParameter } from "../../types/sharetribe";
+/**
+ * Class representing the Stock Adjustments API.
+ *
+ * The Stock Adjustments API provides methods to query and create stock adjustments for marketplace resources.
+ */
+declare class StockAdjustments {
+    private readonly endpoint;
+    private readonly axios;
+    private readonly headers;
+    readonly authRequired = true;
+    /**
+     * Creates an instance of the StockAdjustments class.
+     *
+     * @param {IntegrationApi} api - The Integration API instance providing configuration and request handling.
+     */
+    constructor(api: IntegrationApi);
+    /**
+     * Queries stock adjustment records based on specified filters.
+     *
+     * @template P
+     * @param {P & StockAdjustmentsQueryParameter} params - Query parameters to filter stock adjustment records.
+     * @returns {Promise<AxiosResponse<StockAdjustmentsResponse<'query', P>>>} - A promise resolving to the query results.
+     *
+     * @example
+     * const response = await integrationSdk.stockAdjustments.query({
+     *   listingId: 'resource-id',
+     *   start: '2024-12-01T00:00:00Z',
+     *   end: '2024-12-31T23:59:59Z',
+     * });
+     *
+     * const adjustments = response.data;
+     */
+    query<P extends StockAdjustmentsQueryParameter>(params: P): Promise<AxiosResponse<StockAdjustmentsResponse<"query", P>>>;
+    /**
+     * Creates a new stock adjustment record.
+     *
+     * @template P
+     * @template EP
+     * @param {P & StockAdjustmentsCreateParameter} params - Parameters for the new stock adjustment.
+     * @param {EP | undefined} extraParams - Optional extra parameters for the request.
+     * @returns {Promise<AxiosResponse<StockAdjustmentsResponse<'create', P, EP>>>} - A promise resolving to the created stock adjustment record.
+     *
+     * @example
+     * const response = await integrationSdk.stockAdjustments.create({
+     *   listingId: 'listing-id',
+     *   quantity: 10,
+     * });
+     *
+     * const newAdjustment = response.data;
+     */
+    create<P extends StockAdjustmentsCreateParameter, EP extends ExtraParameter | undefined>(params: P, extraParams: EP): Promise<AxiosResponse<StockAdjustmentsResponse<"create", P, EP>>>;
+}
+export default StockAdjustments;
+//# sourceMappingURL=StockAdjustments.d.ts.map

package/dist/types/endpoints/integrationApi/StockAdjustments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StockAdjustments.d.ts","sourceRoot":"","sources":["../../../../src/endpoints/integrationApi/StockAdjustments.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAiB,aAAa,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,cAAc,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,+BAA+B,EAC/B,8BAA8B,EAC9B,wBAAwB,EACzB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,cAAM,gBAAgB;IACpB,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,KAAK,CAAC,CAAC,SAAS,8BAA8B,EAClD,MAAM,EAAE,CAAC,GACR,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAU/D;;;;;;;;;;;;;;;;OAgBG;IACG,MAAM,CACV,CAAC,SAAS,+BAA+B,EACzC,EAAE,SAAS,cAAc,GAAG,SAAS,EAErC,MAAM,EAAE,CAAC,EACT,WAAW,EAAE,EAAE,GACd,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;CAOrE;AAED,eAAe,gBAAgB,CAAC"}