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

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 {};

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

@@ -0,0 +1,51 @@
+/**
+ * @fileoverview Type definitions for Time Slots in the Sharetribe Marketplace API.
+ */
+import { ApiMeta, ApiParameter, UUID } from "../sharetribe";
+/**
+ * Supported time slot types
+ */
+export type TimeSlotType = "time-slot/day" | "time-slot/time";
+/**
+ * Available endpoints
+ */
+export type TimeSlotsEndpoints = "query";
+/**
+ * Time slot resource
+ */
+export interface TimeSlot {
+    id: UUID;
+    type: "timeSlot";
+    attributes: {
+        type: TimeSlotType;
+        seats: number;
+        start: Date;
+        end: Date;
+    };
+}
+/**
+ * Base request parameters
+ */
+export interface TimeSlotsParameter extends ApiParameter {
+}
+/**
+ * Query parameters for fetching availability
+ */
+export interface TimeSlotsQueryParameter extends TimeSlotsParameter {
+    listingId: UUID | string;
+    start: Date | string;
+    end: Date | string;
+}
+/**
+ * Response data per endpoint
+ */
+type TimeSlotsResponseData<E extends TimeSlotsEndpoints> = E extends "query" ? TimeSlot[] : never;
+/**
+ * Final API response type
+ */
+export type TimeSlotsResponse<E extends TimeSlotsEndpoints = "query"> = {
+    data: TimeSlotsResponseData<E>;
+} & (E extends "query" ? {
+    meta: ApiMeta;
+} : {});
+export {};

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

@@ -0,0 +1,200 @@
+/**
+ * @fileoverview Type definitions for Transactions in the Sharetribe Marketplace API.
+ */
+import { ApiMeta, ApiParameter, ExtraParameter, ExtraParameterType, Money, QueryMeta, QueryProt, Relationship, RelationshipTypeMap, UUID } from "../sharetribe";
+import { BookingState } from "./bookings";
+/**
+ * Available endpoints
+ */
+export type TransactionsEndpoints = "show" | "query" | "initiate" | "initiateSpeculative" | "transition" | "transitionSpeculative" | "updateMetadata";
+/**
+ * Relationship fields that can be included
+ */
+export type TransactionsRelationshipsFields = "marketplace" | "listing" | "listing.marketplace" | "listing.author" | "listing.images" | "listing.currentStock" | "provider" | "provider.profileImage" | "provider.stripeAccount" | "provider.effectivePermissionSet" | "customer" | "customer.profileImage" | "customer.stripeAccount" | "customer.effectivePermissionSet" | "booking" | "stockReservation" | "reviews" | "reviews.author" | "reviews.subject" | "messages" | "messages.sender";
+/**
+ * Roles in a transaction
+ */
+export type TransactionParty = "customer" | "provider";
+/**
+ * Transaction variety
+ */
+export type TransactionVariety = "sale" | "order";
+/**
+ * Line item in a transaction
+ */
+export interface LineItem {
+    code: string;
+    quantity?: number;
+    units?: number;
+    seats?: number;
+    unitPrice: Money;
+    percentage?: number;
+    reversal?: boolean;
+    lineTotal: Money;
+    includeFor: TransactionParty[];
+}
+/**
+ * Process transition record
+ */
+export interface Transition {
+    transition: string;
+    createdAt: Date | string;
+    by: TransactionParty;
+}
+/**
+ * Core transaction attributes (always present)
+ */
+export interface TransactionAttributes {
+    createdAt: Date;
+    processName: string;
+    processVersion: number;
+    lastTransition: string;
+    lastTransitionedAt: string | Date;
+    payinTotal: Money;
+    payoutTotal: Money;
+    lineItems: LineItem[];
+    protectedData: TransactionProtectedData & TransactionCustomProtectedData;
+    metadata: TransactionMetadata & TransactionCustomMetadata;
+    transitions: Transition[];
+}
+/**
+ * Base transaction type
+ */
+export interface Transaction {
+    id: UUID;
+    type: "transaction";
+    attributes: TransactionAttributes;
+}
+/**
+ * Transaction with relationships
+ */
+export interface TransactionWithRelationships extends Transaction {
+    relationships: {
+        marketplace: Relationship<false, "marketplace">;
+        listing: Relationship<false, "listing">;
+        provider: Relationship<false, "provider">;
+        customer: Relationship<false, "customer">;
+        booking: Relationship<false, "booking">;
+        stockReservation: Relationship<false, "stockReservation">;
+        reviews: Relationship<true, "reviews">;
+        messages: Relationship<true, "messages">;
+    };
+}
+/**
+ * Select type based on include
+ */
+export type TransactionType<R extends boolean> = R extends true ? TransactionWithRelationships : Transaction;
+/**
+ * Base API parameter
+ */
+export interface TransactionsParameter extends ApiParameter {
+    include?: TransactionsRelationshipsFields[];
+}
+/**
+ * Show endpoint
+ */
+export interface TransactionsShowParameter extends TransactionsParameter {
+    id: UUID | string;
+}
+/**
+ * Query endpoint (with optional privileged fields when I = true)
+ */
+export type TransactionsQueryParameter<I extends boolean = false> = TransactionsParameter & {
+    bookingEnd?: string;
+    bookingStart?: string;
+    bookingStates?: BookingState[];
+    createdAtEnd?: string;
+    createdAtStart?: string;
+    hasBooking?: boolean;
+    hasMessage?: boolean;
+    hasPayin?: boolean;
+    hasStockReservation?: boolean;
+    lastTransitionedAtStart?: string;
+    lastTransitions?: string[];
+    listingId?: UUID | string;
+    only?: TransactionVariety;
+    processName?: string;
+    stockReservationStates?: string[];
+    userId?: UUID | string;
+    sort?: "bookingEnd" | "bookingStart" | "createdAt" | "lastMessageAt" | "lastTransitionedAt" | `meta_${string}` | `prot_${string}`;
+    [keyof: QueryMeta]: string | undefined;
+    [keyof: QueryProt]: string | undefined;
+} & (I extends true ? {
+    customerId?: UUID | string;
+    providerId?: UUID | string;
+} : {});
+/**
+ * Initiate / Speculative initiate
+ */
+export interface TransactionsInitiateParameter extends TransactionsParameter {
+    processAlias: string;
+    transition: string;
+    params?: unknown;
+}
+export interface TransactionsInitiateSpeculativeParameter extends TransactionsInitiateParameter {
+}
+/**
+ * Transition / Speculative transition
+ */
+export interface TransactionsTransitionParameter extends TransactionsParameter {
+    id: UUID | string;
+    transition: string;
+    params?: unknown;
+}
+export interface TransactionsTransitionSpeculativeParameter extends TransactionsTransitionParameter {
+}
+/**
+ * Update metadata
+ */
+export interface TransactionsUpdateMetadataParameter extends TransactionsParameter {
+    id: UUID | string;
+    metadata?: TransactionMetadata & TransactionCustomMetadata;
+}
+/**
+ * Custom data structures
+ */
+export interface TransactionProtectedData {
+    [key: string]: any;
+}
+export interface TransactionCustomProtectedData extends Record<string, unknown> {
+}
+export interface TransactionMetadata {
+    [key: string]: any;
+}
+export interface TransactionCustomMetadata extends Record<string, unknown> {
+}
+/**
+ * Helpers
+ */
+type HasInclude<P> = P extends {
+    include: infer I extends TransactionsRelationshipsFields[];
+} ? I : never;
+type IncludesRelationships<P> = HasInclude<P> extends never ? false : true;
+type IncludedResources<P> = HasInclude<P> extends infer Fields extends TransactionsRelationshipsFields[] ? RelationshipTypeMap[Fields[number]][] : never;
+/**
+ * Expand behavior (for transition responses)
+ */
+type ExpandResult<T, EP extends ExtraParameter | undefined> = EP extends {
+    expand: true;
+} ? T : EP extends {
+    expand: false;
+} ? Omit<T, "attributes"> : Omit<T, "attributes">;
+/**
+ * Union of all parameter types
+ */
+type AllTransactionsParameter = TransactionsShowParameter | TransactionsQueryParameter<any> | TransactionsInitiateParameter | TransactionsInitiateSpeculativeParameter | TransactionsTransitionParameter | TransactionsTransitionSpeculativeParameter | TransactionsUpdateMetadataParameter;
+/**
+ * Final response data type
+ */
+type TransactionsResponseData<E extends TransactionsEndpoints, P extends AllTransactionsParameter, EP extends ExtraParameter | undefined> = E extends "show" ? TransactionType<IncludesRelationships<P>> : E extends "query" ? TransactionType<IncludesRelationships<P>>[] : E extends "initiate" | "initiateSpeculative" | "transition" | "transitionSpeculative" | "updateMetadata" ? ExpandResult<TransactionType<IncludesRelationships<P>>, EP> : never;
+/**
+ * Final response type
+ */
+export type TransactionsResponse<E extends TransactionsEndpoints, P extends AllTransactionsParameter, EP extends ExtraParameterType = undefined> = {
+    data: TransactionsResponseData<E, P, EP>;
+} & (IncludesRelationships<P> extends true ? {
+    included: IncludedResources<P>;
+} : {}) & (E extends "query" ? {
+    meta: ApiMeta;
+} : {});
+export {};