@voyant-travel/commerce-react 0.1.0

package/dist/promotions/index.d.ts

@@ -0,0 +1,736 @@
+import { type PromotionalOfferApplicationMode, type PromotionalOfferConditions, type PromotionalOfferListStatus, type PromotionalOfferScope, type PromotionalOfferScopeKind } from "@voyant-travel/commerce";
+import { defaultFetcher, useVoyantReactContext, type VoyantFetcher, type VoyantReactContextValue, VoyantReactProvider, type VoyantReactProviderProps } from "@voyant-travel/react";
+import { z } from "zod";
+export { defaultFetcher, useVoyantReactContext as useVoyantPromotionsContext, type VoyantFetcher, type VoyantReactContextValue as VoyantPromotionsContextValue, VoyantReactProvider as VoyantPromotionsProvider, type VoyantReactProviderProps as VoyantPromotionsProviderProps, };
+export { type PromotionalOfferApplicationMode, type PromotionalOfferConditions, type PromotionalOfferListStatus, type PromotionalOfferScope, type PromotionalOfferScopeKind, promotionalOfferConditionsSchema, promotionalOfferScopeSchema, } from "@voyant-travel/commerce";
+declare const promotionalOfferRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    slug: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    discountType: z.ZodEnum<{
+        percentage: "percentage";
+        fixed_amount: "fixed_amount";
+    }>;
+    discountPercent: z.ZodNullable<z.ZodString>;
+    discountAmountCents: z.ZodNullable<z.ZodNumber>;
+    currency: z.ZodNullable<z.ZodString>;
+    scope: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<"global">;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"products">;
+        productIds: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"categories">;
+        categoryIds: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"destinations">;
+        destinationIds: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"markets">;
+        marketIds: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"audiences">;
+        audiences: z.ZodArray<z.ZodEnum<{
+            staff: "staff";
+            customer: "customer";
+            partner: "partner";
+            supplier: "supplier";
+        }>>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"fare_codes">;
+        fareCodes: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<"cabin_grades">;
+        cabinGradeCodes: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>], "kind">;
+    conditions: z.ZodObject<{
+        minPax: z.ZodOptional<z.ZodNumber>;
+        pastGuestOnly: z.ZodOptional<z.ZodBoolean>;
+        soloTravelerOnly: z.ZodOptional<z.ZodBoolean>;
+        childTravelerOnly: z.ZodOptional<z.ZodBoolean>;
+        familyOnly: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>;
+    validFrom: z.ZodNullable<z.ZodString>;
+    validUntil: z.ZodNullable<z.ZodString>;
+    code: z.ZodNullable<z.ZodString>;
+    stackable: z.ZodBoolean;
+    active: z.ZodBoolean;
+    metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export type PromotionalOfferRecord = z.infer<typeof promotionalOfferRecordSchema>;
+export interface PromotionsListQuery {
+    active?: boolean;
+    code?: string;
+    search?: string;
+    applicationMode?: PromotionalOfferApplicationMode;
+    status?: PromotionalOfferListStatus;
+    scopeKind?: PromotionalOfferScopeKind;
+    validFrom?: string;
+    validUntil?: string;
+    limit?: number;
+    offset?: number;
+}
+export interface PromotionsClientOptions {
+    baseUrl: string;
+    fetcher: VoyantFetcher;
+}
+export declare function fetchPromotionsJson<T>(path: string, init: RequestInit, schema: z.ZodType<T>, client: PromotionsClientOptions): Promise<T>;
+export declare function createPromotionsClientOptions(client?: Partial<PromotionsClientOptions>): PromotionsClientOptions;
+export declare class PromotionsApiError extends Error {
+    readonly status: number;
+    readonly body: unknown;
+    constructor(message: string, status: number, body: unknown);
+}
+export declare const promotionsKeys: {
+    all: readonly ["promotions"];
+    list: (query: PromotionsListQuery) => readonly ["promotions", "list", PromotionsListQuery];
+    detail: (id: string) => readonly ["promotions", "detail", string];
+};
+export declare function getPromotionsListQueryOptions(query?: PromotionsListQuery, client?: PromotionsClientOptions): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+    data: {
+        id: string;
+        name: string;
+        slug: string;
+        description: string | null;
+        discountType: "percentage" | "fixed_amount";
+        discountPercent: string | null;
+        discountAmountCents: number | null;
+        currency: string | null;
+        scope: {
+            kind: "global";
+        } | {
+            kind: "products";
+            productIds: string[];
+        } | {
+            kind: "categories";
+            categoryIds: string[];
+        } | {
+            kind: "destinations";
+            destinationIds: string[];
+        } | {
+            kind: "markets";
+            marketIds: string[];
+        } | {
+            kind: "audiences";
+            audiences: ("staff" | "customer" | "partner" | "supplier")[];
+        } | {
+            kind: "fare_codes";
+            fareCodes: string[];
+        } | {
+            kind: "cabin_grades";
+            cabinGradeCodes: string[];
+        };
+        conditions: {
+            minPax?: number | undefined;
+            pastGuestOnly?: boolean | undefined;
+            soloTravelerOnly?: boolean | undefined;
+            childTravelerOnly?: boolean | undefined;
+            familyOnly?: boolean | undefined;
+        };
+        validFrom: string | null;
+        validUntil: string | null;
+        code: string | null;
+        stackable: boolean;
+        active: boolean;
+        metadata: Record<string, unknown> | null;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+    total: number;
+    limit: number;
+    offset: number;
+}, Error, {
+    data: {
+        id: string;
+        name: string;
+        slug: string;
+        description: string | null;
+        discountType: "percentage" | "fixed_amount";
+        discountPercent: string | null;
+        discountAmountCents: number | null;
+        currency: string | null;
+        scope: {
+            kind: "global";
+        } | {
+            kind: "products";
+            productIds: string[];
+        } | {
+            kind: "categories";
+            categoryIds: string[];
+        } | {
+            kind: "destinations";
+            destinationIds: string[];
+        } | {
+            kind: "markets";
+            marketIds: string[];
+        } | {
+            kind: "audiences";
+            audiences: ("staff" | "customer" | "partner" | "supplier")[];
+        } | {
+            kind: "fare_codes";
+            fareCodes: string[];
+        } | {
+            kind: "cabin_grades";
+            cabinGradeCodes: string[];
+        };
+        conditions: {
+            minPax?: number | undefined;
+            pastGuestOnly?: boolean | undefined;
+            soloTravelerOnly?: boolean | undefined;
+            childTravelerOnly?: boolean | undefined;
+            familyOnly?: boolean | undefined;
+        };
+        validFrom: string | null;
+        validUntil: string | null;
+        code: string | null;
+        stackable: boolean;
+        active: boolean;
+        metadata: Record<string, unknown> | null;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+    total: number;
+    limit: number;
+    offset: number;
+}, readonly ["promotions", "list", PromotionsListQuery]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<{
+        data: {
+            id: string;
+            name: string;
+            slug: string;
+            description: string | null;
+            discountType: "percentage" | "fixed_amount";
+            discountPercent: string | null;
+            discountAmountCents: number | null;
+            currency: string | null;
+            scope: {
+                kind: "global";
+            } | {
+                kind: "products";
+                productIds: string[];
+            } | {
+                kind: "categories";
+                categoryIds: string[];
+            } | {
+                kind: "destinations";
+                destinationIds: string[];
+            } | {
+                kind: "markets";
+                marketIds: string[];
+            } | {
+                kind: "audiences";
+                audiences: ("staff" | "customer" | "partner" | "supplier")[];
+            } | {
+                kind: "fare_codes";
+                fareCodes: string[];
+            } | {
+                kind: "cabin_grades";
+                cabinGradeCodes: string[];
+            };
+            conditions: {
+                minPax?: number | undefined;
+                pastGuestOnly?: boolean | undefined;
+                soloTravelerOnly?: boolean | undefined;
+                childTravelerOnly?: boolean | undefined;
+                familyOnly?: boolean | undefined;
+            };
+            validFrom: string | null;
+            validUntil: string | null;
+            code: string | null;
+            stackable: boolean;
+            active: boolean;
+            metadata: Record<string, unknown> | null;
+            createdAt: string;
+            updatedAt: string;
+        }[];
+        total: number;
+        limit: number;
+        offset: number;
+    }, readonly ["promotions", "list", PromotionsListQuery], never> | undefined;
+} & {
+    queryKey: readonly ["promotions", "list", PromotionsListQuery] & {
+        [dataTagSymbol]: {
+            data: {
+                id: string;
+                name: string;
+                slug: string;
+                description: string | null;
+                discountType: "percentage" | "fixed_amount";
+                discountPercent: string | null;
+                discountAmountCents: number | null;
+                currency: string | null;
+                scope: {
+                    kind: "global";
+                } | {
+                    kind: "products";
+                    productIds: string[];
+                } | {
+                    kind: "categories";
+                    categoryIds: string[];
+                } | {
+                    kind: "destinations";
+                    destinationIds: string[];
+                } | {
+                    kind: "markets";
+                    marketIds: string[];
+                } | {
+                    kind: "audiences";
+                    audiences: ("staff" | "customer" | "partner" | "supplier")[];
+                } | {
+                    kind: "fare_codes";
+                    fareCodes: string[];
+                } | {
+                    kind: "cabin_grades";
+                    cabinGradeCodes: string[];
+                };
+                conditions: {
+                    minPax?: number | undefined;
+                    pastGuestOnly?: boolean | undefined;
+                    soloTravelerOnly?: boolean | undefined;
+                    childTravelerOnly?: boolean | undefined;
+                    familyOnly?: boolean | undefined;
+                };
+                validFrom: string | null;
+                validUntil: string | null;
+                code: string | null;
+                stackable: boolean;
+                active: boolean;
+                metadata: Record<string, unknown> | null;
+                createdAt: string;
+                updatedAt: string;
+            }[];
+            total: number;
+            limit: number;
+            offset: number;
+        };
+        [dataTagErrorSymbol]: Error;
+    };
+};
+export declare function getPromotionByIdQueryOptions(id: string, client?: PromotionsClientOptions): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    discountType: "percentage" | "fixed_amount";
+    discountPercent: string | null;
+    discountAmountCents: number | null;
+    currency: string | null;
+    scope: {
+        kind: "global";
+    } | {
+        kind: "products";
+        productIds: string[];
+    } | {
+        kind: "categories";
+        categoryIds: string[];
+    } | {
+        kind: "destinations";
+        destinationIds: string[];
+    } | {
+        kind: "markets";
+        marketIds: string[];
+    } | {
+        kind: "audiences";
+        audiences: ("staff" | "customer" | "partner" | "supplier")[];
+    } | {
+        kind: "fare_codes";
+        fareCodes: string[];
+    } | {
+        kind: "cabin_grades";
+        cabinGradeCodes: string[];
+    };
+    conditions: {
+        minPax?: number | undefined;
+        pastGuestOnly?: boolean | undefined;
+        soloTravelerOnly?: boolean | undefined;
+        childTravelerOnly?: boolean | undefined;
+        familyOnly?: boolean | undefined;
+    };
+    validFrom: string | null;
+    validUntil: string | null;
+    code: string | null;
+    stackable: boolean;
+    active: boolean;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}, Error, {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    discountType: "percentage" | "fixed_amount";
+    discountPercent: string | null;
+    discountAmountCents: number | null;
+    currency: string | null;
+    scope: {
+        kind: "global";
+    } | {
+        kind: "products";
+        productIds: string[];
+    } | {
+        kind: "categories";
+        categoryIds: string[];
+    } | {
+        kind: "destinations";
+        destinationIds: string[];
+    } | {
+        kind: "markets";
+        marketIds: string[];
+    } | {
+        kind: "audiences";
+        audiences: ("staff" | "customer" | "partner" | "supplier")[];
+    } | {
+        kind: "fare_codes";
+        fareCodes: string[];
+    } | {
+        kind: "cabin_grades";
+        cabinGradeCodes: string[];
+    };
+    conditions: {
+        minPax?: number | undefined;
+        pastGuestOnly?: boolean | undefined;
+        soloTravelerOnly?: boolean | undefined;
+        childTravelerOnly?: boolean | undefined;
+        familyOnly?: boolean | undefined;
+    };
+    validFrom: string | null;
+    validUntil: string | null;
+    code: string | null;
+    stackable: boolean;
+    active: boolean;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}, readonly ["promotions", "detail", string]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<{
+        id: string;
+        name: string;
+        slug: string;
+        description: string | null;
+        discountType: "percentage" | "fixed_amount";
+        discountPercent: string | null;
+        discountAmountCents: number | null;
+        currency: string | null;
+        scope: {
+            kind: "global";
+        } | {
+            kind: "products";
+            productIds: string[];
+        } | {
+            kind: "categories";
+            categoryIds: string[];
+        } | {
+            kind: "destinations";
+            destinationIds: string[];
+        } | {
+            kind: "markets";
+            marketIds: string[];
+        } | {
+            kind: "audiences";
+            audiences: ("staff" | "customer" | "partner" | "supplier")[];
+        } | {
+            kind: "fare_codes";
+            fareCodes: string[];
+        } | {
+            kind: "cabin_grades";
+            cabinGradeCodes: string[];
+        };
+        conditions: {
+            minPax?: number | undefined;
+            pastGuestOnly?: boolean | undefined;
+            soloTravelerOnly?: boolean | undefined;
+            childTravelerOnly?: boolean | undefined;
+            familyOnly?: boolean | undefined;
+        };
+        validFrom: string | null;
+        validUntil: string | null;
+        code: string | null;
+        stackable: boolean;
+        active: boolean;
+        metadata: Record<string, unknown> | null;
+        createdAt: string;
+        updatedAt: string;
+    }, readonly ["promotions", "detail", string], never> | undefined;
+} & {
+    queryKey: readonly ["promotions", "detail", string] & {
+        [dataTagSymbol]: {
+            id: string;
+            name: string;
+            slug: string;
+            description: string | null;
+            discountType: "percentage" | "fixed_amount";
+            discountPercent: string | null;
+            discountAmountCents: number | null;
+            currency: string | null;
+            scope: {
+                kind: "global";
+            } | {
+                kind: "products";
+                productIds: string[];
+            } | {
+                kind: "categories";
+                categoryIds: string[];
+            } | {
+                kind: "destinations";
+                destinationIds: string[];
+            } | {
+                kind: "markets";
+                marketIds: string[];
+            } | {
+                kind: "audiences";
+                audiences: ("staff" | "customer" | "partner" | "supplier")[];
+            } | {
+                kind: "fare_codes";
+                fareCodes: string[];
+            } | {
+                kind: "cabin_grades";
+                cabinGradeCodes: string[];
+            };
+            conditions: {
+                minPax?: number | undefined;
+                pastGuestOnly?: boolean | undefined;
+                soloTravelerOnly?: boolean | undefined;
+                childTravelerOnly?: boolean | undefined;
+                familyOnly?: boolean | undefined;
+            };
+            validFrom: string | null;
+            validUntil: string | null;
+            code: string | null;
+            stackable: boolean;
+            active: boolean;
+            metadata: Record<string, unknown> | null;
+            createdAt: string;
+            updatedAt: string;
+        };
+        [dataTagErrorSymbol]: Error;
+    };
+};
+export declare function usePromotionsList(query?: PromotionsListQuery): import("@tanstack/react-query").UseQueryResult<{
+    data: {
+        id: string;
+        name: string;
+        slug: string;
+        description: string | null;
+        discountType: "percentage" | "fixed_amount";
+        discountPercent: string | null;
+        discountAmountCents: number | null;
+        currency: string | null;
+        scope: {
+            kind: "global";
+        } | {
+            kind: "products";
+            productIds: string[];
+        } | {
+            kind: "categories";
+            categoryIds: string[];
+        } | {
+            kind: "destinations";
+            destinationIds: string[];
+        } | {
+            kind: "markets";
+            marketIds: string[];
+        } | {
+            kind: "audiences";
+            audiences: ("staff" | "customer" | "partner" | "supplier")[];
+        } | {
+            kind: "fare_codes";
+            fareCodes: string[];
+        } | {
+            kind: "cabin_grades";
+            cabinGradeCodes: string[];
+        };
+        conditions: {
+            minPax?: number | undefined;
+            pastGuestOnly?: boolean | undefined;
+            soloTravelerOnly?: boolean | undefined;
+            childTravelerOnly?: boolean | undefined;
+            familyOnly?: boolean | undefined;
+        };
+        validFrom: string | null;
+        validUntil: string | null;
+        code: string | null;
+        stackable: boolean;
+        active: boolean;
+        metadata: Record<string, unknown> | null;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+    total: number;
+    limit: number;
+    offset: number;
+}, Error>;
+export interface PromotionInsertInput {
+    name: string;
+    slug: string;
+    description?: string | null;
+    discountType: "percentage" | "fixed_amount";
+    discountPercent?: number | null;
+    discountAmountCents?: number | null;
+    currency?: string | null;
+    scope: PromotionalOfferScope;
+    conditions?: PromotionalOfferConditions;
+    validFrom?: string | null;
+    validUntil?: string | null;
+    code?: string | null;
+    stackable?: boolean;
+    active?: boolean;
+}
+export type PromotionUpdateInput = Partial<PromotionInsertInput>;
+export declare function useCreatePromotion(): import("@tanstack/react-query").UseMutationResult<{
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    discountType: "percentage" | "fixed_amount";
+    discountPercent: string | null;
+    discountAmountCents: number | null;
+    currency: string | null;
+    scope: {
+        kind: "global";
+    } | {
+        kind: "products";
+        productIds: string[];
+    } | {
+        kind: "categories";
+        categoryIds: string[];
+    } | {
+        kind: "destinations";
+        destinationIds: string[];
+    } | {
+        kind: "markets";
+        marketIds: string[];
+    } | {
+        kind: "audiences";
+        audiences: ("staff" | "customer" | "partner" | "supplier")[];
+    } | {
+        kind: "fare_codes";
+        fareCodes: string[];
+    } | {
+        kind: "cabin_grades";
+        cabinGradeCodes: string[];
+    };
+    conditions: {
+        minPax?: number | undefined;
+        pastGuestOnly?: boolean | undefined;
+        soloTravelerOnly?: boolean | undefined;
+        childTravelerOnly?: boolean | undefined;
+        familyOnly?: boolean | undefined;
+    };
+    validFrom: string | null;
+    validUntil: string | null;
+    code: string | null;
+    stackable: boolean;
+    active: boolean;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}, Error, PromotionInsertInput, unknown>;
+export declare function useUpdatePromotion(): import("@tanstack/react-query").UseMutationResult<{
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    discountType: "percentage" | "fixed_amount";
+    discountPercent: string | null;
+    discountAmountCents: number | null;
+    currency: string | null;
+    scope: {
+        kind: "global";
+    } | {
+        kind: "products";
+        productIds: string[];
+    } | {
+        kind: "categories";
+        categoryIds: string[];
+    } | {
+        kind: "destinations";
+        destinationIds: string[];
+    } | {
+        kind: "markets";
+        marketIds: string[];
+    } | {
+        kind: "audiences";
+        audiences: ("staff" | "customer" | "partner" | "supplier")[];
+    } | {
+        kind: "fare_codes";
+        fareCodes: string[];
+    } | {
+        kind: "cabin_grades";
+        cabinGradeCodes: string[];
+    };
+    conditions: {
+        minPax?: number | undefined;
+        pastGuestOnly?: boolean | undefined;
+        soloTravelerOnly?: boolean | undefined;
+        childTravelerOnly?: boolean | undefined;
+        familyOnly?: boolean | undefined;
+    };
+    validFrom: string | null;
+    validUntil: string | null;
+    code: string | null;
+    stackable: boolean;
+    active: boolean;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}, Error, {
+    id: string;
+    patch: PromotionUpdateInput;
+}, unknown>;
+export declare function useArchivePromotion(): import("@tanstack/react-query").UseMutationResult<{
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    discountType: "percentage" | "fixed_amount";
+    discountPercent: string | null;
+    discountAmountCents: number | null;
+    currency: string | null;
+    scope: {
+        kind: "global";
+    } | {
+        kind: "products";
+        productIds: string[];
+    } | {
+        kind: "categories";
+        categoryIds: string[];
+    } | {
+        kind: "destinations";
+        destinationIds: string[];
+    } | {
+        kind: "markets";
+        marketIds: string[];
+    } | {
+        kind: "audiences";
+        audiences: ("staff" | "customer" | "partner" | "supplier")[];
+    } | {
+        kind: "fare_codes";
+        fareCodes: string[];
+    } | {
+        kind: "cabin_grades";
+        cabinGradeCodes: string[];
+    };
+    conditions: {
+        minPax?: number | undefined;
+        pastGuestOnly?: boolean | undefined;
+        soloTravelerOnly?: boolean | undefined;
+        childTravelerOnly?: boolean | undefined;
+        familyOnly?: boolean | undefined;
+    };
+    validFrom: string | null;
+    validUntil: string | null;
+    code: string | null;
+    stackable: boolean;
+    active: boolean;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}, Error, string, unknown>;
+export declare function useDeletePromotion(): import("@tanstack/react-query").UseMutationResult<{
+    id: string;
+}, Error, string, unknown>;
+//# sourceMappingURL=index.d.ts.map