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

package/dist/types/marketplace/reviews.d.ts

@@ -0,0 +1,108 @@
+/**
+ * @fileoverview Type definitions for Reviews in the Sharetribe Marketplace API.
+ */
+import { ApiMeta, ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type ReviewsEndpoints = "show" | "query";
+/**
+ * Relationship fields that can be included
+ */
+export type ReviewsRelationshipsFields = "author" | "author.profileImage" | "author.marketplace" | "author.stripeAccount" | "author.effectivePermissionSet" | "listing" | "listing.marketplace" | "listing.author" | "listing.images" | "listing.currentStock" | "subject" | "subject.profileImage" | "subject.marketplace" | "subject.stripeAccount" | "subject.effectivePermissionSet";
+/**
+ * Review types and states
+ */
+export type ReviewType = "ofProvider" | "ofCustomer";
+export type ReviewState = "public" | "pending";
+/**
+ * Review resource
+ */
+export interface Review {
+    id: UUID;
+    type: "review";
+    attributes: {
+        type: ReviewType;
+        state: ReviewState;
+        rating: number;
+        content: string;
+        createdAt: Date;
+        deleted: boolean;
+    };
+}
+/**
+ * With relationships
+ */
+export interface ReviewWithRelationships extends Review {
+    relationships: {
+        author: Relationship<false, "author">;
+        listing?: Relationship<false, "listing">;
+        subject: Relationship<false, "subject">;
+    };
+}
+/**
+ * Select type based on include
+ */
+export type ReviewResource<R extends boolean> = R extends true ? ReviewWithRelationships : Review;
+/**
+ * Base request parameters
+ */
+export interface ReviewsParameter extends ApiParameter {
+    include?: ReviewsRelationshipsFields[];
+}
+/**
+ * Show endpoint
+ */
+export interface ReviewsShowParameter extends ReviewsParameter {
+    id: UUID | string;
+}
+/**
+ * Query endpoint
+ */
+export interface ReviewsQueryParameter extends ReviewsParameter {
+    transactionId?: UUID | string;
+    listingId?: UUID | string;
+    subjectId?: UUID | string;
+    type?: ReviewType;
+    state?: ReviewState;
+}
+/**
+ * All parameter types
+ */
+type AllReviewsParameter = ReviewsShowParameter | ReviewsQueryParameter;
+/**
+ * Detect include — fixed for TS2536
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends readonly ReviewsRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+/**
+ * Included resources — bulletproof
+ */
+type IncludedResources<P> = P extends {
+    include: infer I extends readonly ReviewsRelationshipsFields[];
+} ? RelationshipTypeMap[I[number]][] : never;
+/**
+ * Expand behavior
+ */
+type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? T : EP extends {
+    expand: false;
+} ? Omit<T, "attributes"> : Omit<T, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends ReviewsEndpoints, P extends AllReviewsParameter, EP extends ExtraParameterType | undefined> = E extends "query" ? ReviewResource<IncludesRelationships<P>>[] : E extends "show" ? ExpandResult<ReviewResource<IncludesRelationships<P>>, EP> : never;
+/**
+ * Final response type
+ */
+export type ReviewsResponse<E extends ReviewsEndpoints, P extends AllReviewsParameter, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {}) & (E extends "query" ? {
+    meta: ApiMeta;
+} : {});
+export {};

package/dist/types/marketplace/stock.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @fileoverview Type definitions for Stock operations in the Sharetribe Marketplace API.
+ */
+import { ExtraParameterType, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type StockEndpoints = "compareAndSet";
+/**
+ * Stock resource
+ */
+export interface Stock {
+    id: UUID;
+    type: "stock";
+    attributes: {
+        quantity: number;
+    };
+}
+/**
+ * Parameters for compare-and-set operation
+ */
+export interface StockCompareAndSetParameter {
+    listingId: UUID | string;
+    oldTotal: number;
+    newTotal: number;
+}
+/**
+ * Expand behavior
+ */
+type ExpandResult<EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? Stock : EP extends {
+    expand: false;
+} ? Omit<Stock, "attributes"> : Omit<Stock, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends StockEndpoints, EP extends ExtraParameterType | undefined> = E extends "compareAndSet" ? ExpandResult<EP> : never;
+/**
+ * Final response type
+ */
+export type StockResponse<E extends StockEndpoints = "compareAndSet", EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, EP>;
+};
+export {};

package/dist/types/marketplace/stockAdjustment.d.ts

@@ -0,0 +1,97 @@
+/**
+ * @fileoverview Type definitions for Stock Adjustments in the Sharetribe Marketplace API.
+ */
+import { ApiMeta, ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type StockAdjustmentsEndpoints = "query" | "create" | "delete";
+/**
+ * Relationship fields that can be included
+ */
+export type StockAdjustmentsRelationshipsFields = "ownListing" | "ownListing.marketplace" | "ownListing.author" | "ownListing.images" | "ownListing.currentStock" | "stockReservation";
+/**
+ * Stock Adjustment resource
+ */
+export interface StockAdjustment {
+    id: UUID;
+    type: "stockAdjustment";
+    attributes: {
+        at: Date;
+        quantity: number;
+    };
+}
+/**
+ * With relationships
+ */
+export interface StockAdjustmentWithRelationships extends StockAdjustment {
+    relationships: {
+        ownListing: Relationship<false, "ownListing">;
+        stockReservation: Relationship<false, "stockReservation">;
+    };
+}
+/**
+ * Select type based on include
+ */
+export type StockAdjustmentType<R extends boolean> = R extends true ? StockAdjustmentWithRelationships : StockAdjustment;
+/**
+ * Base request parameters
+ */
+export interface StockAdjustmentsParameter extends ApiParameter {
+    include?: StockAdjustmentsRelationshipsFields[];
+}
+/**
+ * Query endpoint
+ */
+export interface StockAdjustmentsQueryParameter extends StockAdjustmentsParameter {
+    listingId: UUID | string;
+    start: Date | string;
+    end: Date | string;
+}
+/**
+ * Create endpoint
+ */
+export interface StockAdjustmentsCreateParameter extends StockAdjustmentsParameter {
+    listingId: UUID | string;
+    quantity: number;
+}
+/**
+ * All parameter types
+ */
+type AllStockAdjustmentsParameter = StockAdjustmentsQueryParameter | StockAdjustmentsCreateParameter;
+/**
+ * Detect include + fix TS2536
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends readonly StockAdjustmentsRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+/**
+ * Included resources — bulletproof version (no TS2536)
+ */
+type IncludedResources<P> = P extends {
+    include: infer I extends readonly StockAdjustmentsRelationshipsFields[];
+} ? RelationshipTypeMap[I[number]][] : never;
+/**
+ * Expand behavior
+ */
+type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? T : EP extends {
+    expand: false;
+} ? Omit<T, "attributes"> : Omit<T, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends StockAdjustmentsEndpoints, P extends AllStockAdjustmentsParameter, EP extends ExtraParameterType | undefined> = E extends "query" ? StockAdjustmentType<IncludesRelationships<P>>[] : E extends "create" ? ExpandResult<StockAdjustmentType<IncludesRelationships<P>>, EP> : E extends "delete" ? Pick<StockAdjustment, "id" | "type"> : never;
+/**
+ * Final response type
+ */
+export type StockAdjustmentsResponse<E extends StockAdjustmentsEndpoints, P extends AllStockAdjustmentsParameter, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {}) & (E extends "query" ? {
+    meta: ApiMeta;
+} : {});
+export {};

package/dist/types/marketplace/stockReservations.d.ts

@@ -0,0 +1,89 @@
+/**
+ * @fileoverview Type definitions for Stock Reservations in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type StockReservationsEndpoints = "show";
+/**
+ * Relationship fields that can be included
+ */
+export type StockReservationsRelationshipsFields = "transaction" | "transaction.marketplace" | "transaction.listing" | "transaction.provider" | "transaction.customer" | "transaction.booking" | "transaction.stockReservation" | "transaction.reviews" | "transaction.messages";
+/**
+ * Possible reservation states
+ */
+export type StockReservationState = "pending" | "proposed" | "accepted" | "declined" | "cancelled";
+/**
+ * Stock Reservation resource
+ */
+export interface StockReservation {
+    id: UUID;
+    type: "stockReservation";
+    attributes: {
+        quantity: number;
+        state: StockReservationState;
+    };
+}
+/**
+ * With relationships
+ */
+export interface StockReservationWithRelationships extends StockReservation {
+    relationships: {
+        listing: Relationship<false, "listing">;
+        transaction: Relationship<false, "transaction">;
+        stockAdjustments: Relationship<true, "stockAdjustment">;
+    };
+}
+/**
+ * Select type based on include
+ */
+export type StockReservationType<R extends boolean> = R extends true ? StockReservationWithRelationships : StockReservation;
+/**
+ * Base request parameters
+ */
+export interface StockReservationParameter extends ApiParameter {
+    include?: StockReservationsRelationshipsFields[];
+}
+/**
+ * Show endpoint parameters
+ */
+export interface StockReservationShowParameter extends StockReservationParameter {
+    id: UUID | string;
+}
+/**
+ * All parameter types
+ */
+type AllStockReservationsParameter = StockReservationShowParameter;
+/**
+ * Detect include usage
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends StockReservationsRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+/**
+ * Included resources — fixed version (no TS2536)
+ */
+type IncludedResources<P> = HasInclude<P> extends infer Fields extends StockReservationsRelationshipsFields[] ? RelationshipTypeMap[Fields[number]][] : never;
+/**
+ * Expand behavior
+ */
+type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? T : EP extends {
+    expand: false;
+} ? Omit<T, "attributes"> : Omit<T, "attributes">;
+/**
+ * Response data
+ */
+type ResponseData<E extends StockReservationsEndpoints, P extends AllStockReservationsParameter, EP extends ExtraParameterType | undefined> = E extends "show" ? ExpandResult<StockReservationType<IncludesRelationships<P>>, EP> : never;
+/**
+ * Final response type
+ */
+export type StockReservationsResponse<E extends StockReservationsEndpoints = "show", P extends AllStockReservationsParameter = StockReservationShowParameter, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {});
+export {};

package/dist/types/marketplace/stripeAccount.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @fileoverview Type definitions for Stripe Account operations in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, ExtraParameterType, UUID } from "../sharetribe";
+import type Stripe from "stripe";
+/**
+ * Available endpoints
+ */
+export type StripeAccountEndpoints = "fetch" | "create" | "update";
+/**
+ * Stripe Account resource
+ */
+export interface StripeAccount {
+    id: UUID;
+    type: "stripeAccount";
+    attributes: {
+        stripeAccountId: string;
+        stripeAccountData: Stripe.Account;
+    };
+}
+/**
+ * Base request parameters
+ */
+export interface StripeAccountParameter extends ApiParameter {
+}
+/**
+ * Parameters for creating a Stripe Account
+ */
+export interface StripeAccountCreateParameter extends StripeAccountParameter {
+    country: string;
+    accountToken?: string;
+    bankAccountToken?: string;
+    businessProfileMCC?: string;
+    businessProfileURL?: string;
+    businessProfileProductDescription?: string;
+    requestedCapabilities?: string[];
+}
+/**
+ * Parameters for updating a Stripe Account
+ */
+export interface StripeAccountUpdateParameter extends StripeAccountParameter {
+    accountToken?: string;
+    bankAccountToken?: string;
+    businessProfileMCC?: string;
+    businessProfileURL?: string;
+    businessProfileProductDescription?: string;
+    requestedCapabilities?: string[];
+}
+/**
+ * Expand behavior
+ */
+type ExpandResult<EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? StripeAccount : EP extends {
+    expand: false;
+} ? Omit<StripeAccount, "attributes"> : Omit<StripeAccount, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends StripeAccountEndpoints, EP extends ExtraParameterType | undefined> = E extends "fetch" ? StripeAccount : E extends "create" | "update" ? ExpandResult<EP> : never;
+/**
+ * Final response type
+ */
+export type StripeAccountResponse<E extends StripeAccountEndpoints, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, EP>;
+};
+export {};

package/dist/types/marketplace/stripeAccountLinks.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @fileoverview Type definitions for Stripe Account Links in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, ExtraParameterType, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type StripeAccountLinksEndpoints = "create";
+/**
+ * Stripe Account Link resource
+ */
+export interface StripeAccountLink {
+    id: UUID;
+    type: "stripeAccountLink";
+    attributes: {
+        url: string;
+        expiresAt: Date;
+    };
+}
+/**
+ * Base request parameters
+ */
+export interface StripeAccountLinksParameter extends ApiParameter {
+}
+/**
+ * Parameters for creating an account link
+ */
+export interface StripeAccountLinksCreateParameter extends StripeAccountLinksParameter {
+    failureURL: string;
+    successURL: string;
+    type: string;
+    collectionOptions: {
+        fields: Array<"currently_due" | "eventually_due">;
+        future_requirements: Array<"include" | "omit">;
+    };
+}
+/**
+ * Expand behavior
+ */
+type ExpandResult<EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? StripeAccountLink : EP extends {
+    expand: false;
+} ? Omit<StripeAccountLink, "attributes"> : Omit<StripeAccountLink, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends StripeAccountLinksEndpoints, EP extends ExtraParameterType | undefined> = E extends "create" ? ExpandResult<EP> : never;
+/**
+ * Final response type
+ */
+export type StripeAccountLinksResponse<E extends StripeAccountLinksEndpoints = "create", EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, EP>;
+};
+export {};

package/dist/types/marketplace/stripeCustomer.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @fileoverview Type definitions for Stripe Customer operations in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, ExtraParameterType, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type StripeCustomerEndpoints = "create" | "addPaymentMethod" | "deletePaymentMethod";
+/**
+ * Relationship fields that can be included
+ */
+export type StripeCustomerRelationshipsFields = "defaultPaymentMethod";
+/**
+ * Stripe Customer resource
+ */
+export interface StripeCustomer {
+    id: UUID;
+    type: "stripeCustomer";
+    attributes: {
+        stripeCustomerId: string;
+    };
+}
+/**
+ * Stripe Customer with relationships
+ */
+export interface StripeCustomerWithRelationships extends StripeCustomer {
+    relationships: {
+        defaultPaymentMethod: Relationship<false, "defaultPaymentMethod">;
+    };
+}
+/**
+ * Select type based on include
+ */
+export type StripeCustomerType<R extends boolean> = R extends true ? StripeCustomerWithRelationships : StripeCustomer;
+/**
+ * Base request parameters
+ */
+export interface StripeCustomerParameter extends ApiParameter {
+    include?: StripeCustomerRelationshipsFields[];
+}
+/**
+ * Create endpoint
+ */
+export interface StripeCustomerCreateParameter extends StripeCustomerParameter {
+    stripePaymentMethodId?: string;
+    stripeCustomerEmail?: string;
+}
+/**
+ * Add payment method
+ */
+export interface StripeCustomerAddPaymentMethodParameter extends StripeCustomerParameter {
+    stripePaymentMethodId: string;
+}
+/**
+ * Delete payment method (no body required)
+ */
+export interface StripeCustomerDeletePaymentMethodParameter extends StripeCustomerParameter {
+}
+/**
+ * All parameter types
+ */
+type AllStripeCustomerParameter = StripeCustomerCreateParameter | StripeCustomerAddPaymentMethodParameter | StripeCustomerDeletePaymentMethodParameter;
+/**
+ * Detect if relationships are requested
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends StripeCustomerRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+/**
+ * Included resources (when include is used)
+ */
+type IncludedResources<P> = HasInclude<P> extends infer Fields extends StripeCustomerRelationshipsFields[] ? RelationshipTypeMap[Fields[number]][] : never;
+/**
+ * Expand behavior
+ */
+type ExpandResult<T, EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? T : EP extends {
+    expand: false;
+} ? Omit<T, "attributes"> : Omit<T, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends StripeCustomerEndpoints, P extends AllStripeCustomerParameter, EP extends ExtraParameterType | undefined> = E extends "create" | "addPaymentMethod" | "deletePaymentMethod" ? ExpandResult<StripeCustomerType<IncludesRelationships<P>>, EP> : never;
+/**
+ * Final response type
+ */
+export type StripeCustomerResponse<E extends StripeCustomerEndpoints, P extends AllStripeCustomerParameter, EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {});
+export {};

package/dist/types/marketplace/stripePaymentMethod.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @fileoverview Type definition for Stripe Payment Method objects in the Sharetribe Marketplace API.
+ */
+import { UUID } from "../sharetribe";
+/**
+ * Stripe Payment Method resource
+ */
+export interface StripePaymentMethod {
+    id: UUID;
+    type: "stripePaymentMethod";
+    attributes: {
+        type: string;
+        stripePaymentMethodId: string;
+        card: {
+            brand: string;
+            last4Digits: string;
+            expirationYear: number;
+            expirationMonth: number;
+        };
+    };
+}

package/dist/types/marketplace/stripePersons.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @fileoverview Type definitions for Stripe Persons in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, ExtraParameterType, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type StripePersonsEndpoints = "create";
+/**
+ * Stripe Person resource
+ */
+export interface StripePerson {
+    id: UUID;
+    type: "stripePerson";
+    attributes: {
+        stripePersonId: string;
+    };
+}
+/**
+ * Base request parameters
+ */
+export interface StripePersonsParameter extends ApiParameter {
+}
+/**
+ * Parameters for creating a Stripe Person
+ */
+export interface StripePersonsCreateParameter extends StripePersonsParameter {
+    personToken: string;
+}
+/**
+ * Expand behavior (controls inclusion of `attributes`)
+ */
+type ExpandResult<EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? StripePerson : EP extends {
+    expand: false;
+} ? Omit<StripePerson, "attributes"> : Omit<StripePerson, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends StripePersonsEndpoints, EP extends ExtraParameterType | undefined> = E extends "create" ? ExpandResult<EP> : never;
+/**
+ * Final response type
+ */
+export type StripePersonsResponse<E extends StripePersonsEndpoints = "create", EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, EP>;
+};
+export {};

package/dist/types/marketplace/stripeSetupIntents.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @fileoverview Type definitions for Stripe Setup Intents in the Sharetribe Marketplace API.
+ */
+import { ApiParameter, ExtraParameterType, UUID } from "../sharetribe";
+/**
+ * Available endpoints
+ */
+export type StripeSetupIntentsEndpoints = "create";
+/**
+ * Stripe Setup Intent resource
+ */
+export interface StripeSetupIntent {
+    id: UUID;
+    type: "stripeSetupIntent";
+    attributes: {
+        stripeSetupIntentId: string;
+        clientSecret: string;
+    };
+}
+/**
+ * Base request parameters
+ */
+export interface StripeSetupIntentsParameter extends ApiParameter {
+}
+/**
+ * Parameters for creating a setup intent
+ */
+export interface StripeSetupIntentsCreateParameter extends StripeSetupIntentsParameter {
+}
+/**
+ * Expand behavior (controls whether `attributes` is included)
+ */
+type ExpandResult<EP extends ExtraParameterType | undefined> = EP extends {
+    expand: true;
+} ? StripeSetupIntent : EP extends {
+    expand: false;
+} ? Omit<StripeSetupIntent, "attributes"> : Omit<StripeSetupIntent, "attributes">;
+/**
+ * Response data per endpoint
+ */
+type ResponseData<E extends StripeSetupIntentsEndpoints, EP extends ExtraParameterType | undefined> = E extends "create" ? ExpandResult<EP> : never;
+/**
+ * Final response type
+ */
+export type StripeSetupIntentsResponse<E extends StripeSetupIntentsEndpoints = "create", EP extends ExtraParameterType | undefined = undefined> = {
+    data: ResponseData<E, EP>;
+};
+export {};