@voyant-travel/finance-react 0.119.5

package/dist/schemas/profitability.d.ts

@@ -0,0 +1,333 @@
+import { z } from "zod";
+export declare const profitabilityCostByServiceTypeSchema: z.ZodObject<{
+    serviceType: z.ZodString;
+    currency: z.ZodString;
+    amountCents: z.ZodNumber;
+}, z.core.$strip>;
+export type ProfitabilityCostByServiceType = z.infer<typeof profitabilityCostByServiceTypeSchema>;
+export declare const profitabilityUnattributedSchema: z.ZodObject<{
+    currency: z.ZodString;
+    amountCents: z.ZodNumber;
+}, z.core.$strip>;
+export type ProfitabilityUnattributed = z.infer<typeof profitabilityUnattributedSchema>;
+export declare const departureProfitabilityRowSchema: z.ZodObject<{
+    departureId: z.ZodString;
+    departureLabel: z.ZodNullable<z.ZodString>;
+    productId: z.ZodNullable<z.ZodString>;
+    productName: z.ZodNullable<z.ZodString>;
+    departureDate: z.ZodNullable<z.ZodString>;
+    currency: z.ZodString;
+    revenueCents: z.ZodNumber;
+    actualCostCents: z.ZodNumber;
+    plannedCostCents: z.ZodNumber;
+    profitCents: z.ZodNumber;
+    marginPercent: z.ZodNullable<z.ZodNumber>;
+    varianceCents: z.ZodNumber;
+}, z.core.$strip>;
+export type DepartureProfitabilityRow = z.infer<typeof departureProfitabilityRowSchema>;
+export declare const departureProfitabilityBaseRollupSchema: z.ZodObject<{
+    currency: z.ZodString;
+    rows: z.ZodArray<z.ZodObject<{
+        departureId: z.ZodString;
+        departureLabel: z.ZodNullable<z.ZodString>;
+        productId: z.ZodNullable<z.ZodString>;
+        productName: z.ZodNullable<z.ZodString>;
+        departureDate: z.ZodNullable<z.ZodString>;
+        currency: z.ZodString;
+        revenueCents: z.ZodNumber;
+        actualCostCents: z.ZodNumber;
+        plannedCostCents: z.ZodNumber;
+        profitCents: z.ZodNumber;
+        marginPercent: z.ZodNullable<z.ZodNumber>;
+        varianceCents: z.ZodNumber;
+    }, z.core.$strip>>;
+    costByServiceType: z.ZodArray<z.ZodObject<{
+        serviceType: z.ZodString;
+        currency: z.ZodString;
+        amountCents: z.ZodNumber;
+    }, z.core.$strip>>;
+    unattributedCents: z.ZodNumber;
+    unconvertibleCurrencies: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type DepartureProfitabilityBaseRollup = z.infer<typeof departureProfitabilityBaseRollupSchema>;
+export declare const departureProfitabilityReportSchema: z.ZodObject<{
+    rows: z.ZodArray<z.ZodObject<{
+        departureId: z.ZodString;
+        departureLabel: z.ZodNullable<z.ZodString>;
+        productId: z.ZodNullable<z.ZodString>;
+        productName: z.ZodNullable<z.ZodString>;
+        departureDate: z.ZodNullable<z.ZodString>;
+        currency: z.ZodString;
+        revenueCents: z.ZodNumber;
+        actualCostCents: z.ZodNumber;
+        plannedCostCents: z.ZodNumber;
+        profitCents: z.ZodNumber;
+        marginPercent: z.ZodNullable<z.ZodNumber>;
+        varianceCents: z.ZodNumber;
+    }, z.core.$strip>>;
+    costByServiceType: z.ZodArray<z.ZodObject<{
+        serviceType: z.ZodString;
+        currency: z.ZodString;
+        amountCents: z.ZodNumber;
+    }, z.core.$strip>>;
+    unattributed: z.ZodArray<z.ZodObject<{
+        currency: z.ZodString;
+        amountCents: z.ZodNumber;
+    }, z.core.$strip>>;
+    base: z.ZodOptional<z.ZodObject<{
+        currency: z.ZodString;
+        rows: z.ZodArray<z.ZodObject<{
+            departureId: z.ZodString;
+            departureLabel: z.ZodNullable<z.ZodString>;
+            productId: z.ZodNullable<z.ZodString>;
+            productName: z.ZodNullable<z.ZodString>;
+            departureDate: z.ZodNullable<z.ZodString>;
+            currency: z.ZodString;
+            revenueCents: z.ZodNumber;
+            actualCostCents: z.ZodNumber;
+            plannedCostCents: z.ZodNumber;
+            profitCents: z.ZodNumber;
+            marginPercent: z.ZodNullable<z.ZodNumber>;
+            varianceCents: z.ZodNumber;
+        }, z.core.$strip>>;
+        costByServiceType: z.ZodArray<z.ZodObject<{
+            serviceType: z.ZodString;
+            currency: z.ZodString;
+            amountCents: z.ZodNumber;
+        }, z.core.$strip>>;
+        unattributedCents: z.ZodNumber;
+        unconvertibleCurrencies: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type DepartureProfitabilityReport = z.infer<typeof departureProfitabilityReportSchema>;
+export declare const productProfitabilityRowSchema: z.ZodObject<{
+    productId: z.ZodString;
+    productName: z.ZodNullable<z.ZodString>;
+    currency: z.ZodString;
+    departureCount: z.ZodNumber;
+    revenueCents: z.ZodNumber;
+    actualCostCents: z.ZodNumber;
+    plannedCostCents: z.ZodNumber;
+    profitCents: z.ZodNumber;
+    marginPercent: z.ZodNullable<z.ZodNumber>;
+    varianceCents: z.ZodNumber;
+}, z.core.$strip>;
+export type ProductProfitabilityRow = z.infer<typeof productProfitabilityRowSchema>;
+export declare const productProfitabilityBaseRollupSchema: z.ZodObject<{
+    currency: z.ZodString;
+    rows: z.ZodArray<z.ZodObject<{
+        productId: z.ZodString;
+        productName: z.ZodNullable<z.ZodString>;
+        currency: z.ZodString;
+        departureCount: z.ZodNumber;
+        revenueCents: z.ZodNumber;
+        actualCostCents: z.ZodNumber;
+        plannedCostCents: z.ZodNumber;
+        profitCents: z.ZodNumber;
+        marginPercent: z.ZodNullable<z.ZodNumber>;
+        varianceCents: z.ZodNumber;
+    }, z.core.$strip>>;
+    costByServiceType: z.ZodArray<z.ZodObject<{
+        serviceType: z.ZodString;
+        currency: z.ZodString;
+        amountCents: z.ZodNumber;
+    }, z.core.$strip>>;
+    unattributedCents: z.ZodNumber;
+    unconvertibleCurrencies: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type ProductProfitabilityBaseRollup = z.infer<typeof productProfitabilityBaseRollupSchema>;
+export declare const productProfitabilityReportSchema: z.ZodObject<{
+    rows: z.ZodArray<z.ZodObject<{
+        productId: z.ZodString;
+        productName: z.ZodNullable<z.ZodString>;
+        currency: z.ZodString;
+        departureCount: z.ZodNumber;
+        revenueCents: z.ZodNumber;
+        actualCostCents: z.ZodNumber;
+        plannedCostCents: z.ZodNumber;
+        profitCents: z.ZodNumber;
+        marginPercent: z.ZodNullable<z.ZodNumber>;
+        varianceCents: z.ZodNumber;
+    }, z.core.$strip>>;
+    costByServiceType: z.ZodArray<z.ZodObject<{
+        serviceType: z.ZodString;
+        currency: z.ZodString;
+        amountCents: z.ZodNumber;
+    }, z.core.$strip>>;
+    unattributed: z.ZodArray<z.ZodObject<{
+        currency: z.ZodString;
+        amountCents: z.ZodNumber;
+    }, z.core.$strip>>;
+    base: z.ZodOptional<z.ZodObject<{
+        currency: z.ZodString;
+        rows: z.ZodArray<z.ZodObject<{
+            productId: z.ZodString;
+            productName: z.ZodNullable<z.ZodString>;
+            currency: z.ZodString;
+            departureCount: z.ZodNumber;
+            revenueCents: z.ZodNumber;
+            actualCostCents: z.ZodNumber;
+            plannedCostCents: z.ZodNumber;
+            profitCents: z.ZodNumber;
+            marginPercent: z.ZodNullable<z.ZodNumber>;
+            varianceCents: z.ZodNumber;
+        }, z.core.$strip>>;
+        costByServiceType: z.ZodArray<z.ZodObject<{
+            serviceType: z.ZodString;
+            currency: z.ZodString;
+            amountCents: z.ZodNumber;
+        }, z.core.$strip>>;
+        unattributedCents: z.ZodNumber;
+        unconvertibleCurrencies: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ProductProfitabilityReport = z.infer<typeof productProfitabilityReportSchema>;
+export declare const travelerProfitabilityRowSchema: z.ZodObject<{
+    travelerId: z.ZodString;
+    travelerName: z.ZodString;
+    bookingId: z.ZodString;
+    currency: z.ZodString;
+    revenueCents: z.ZodNumber;
+    actualCostCents: z.ZodNumber;
+    plannedCostCents: z.ZodNumber;
+    profitCents: z.ZodNumber;
+    marginPercent: z.ZodNullable<z.ZodNumber>;
+    varianceCents: z.ZodNumber;
+}, z.core.$strip>;
+export type TravelerProfitabilityRow = z.infer<typeof travelerProfitabilityRowSchema>;
+export declare const travelerProfitabilityReportSchema: z.ZodObject<{
+    departureId: z.ZodString;
+    currency: z.ZodString;
+    travelerCount: z.ZodNumber;
+    rows: z.ZodArray<z.ZodObject<{
+        travelerId: z.ZodString;
+        travelerName: z.ZodString;
+        bookingId: z.ZodString;
+        currency: z.ZodString;
+        revenueCents: z.ZodNumber;
+        actualCostCents: z.ZodNumber;
+        plannedCostCents: z.ZodNumber;
+        profitCents: z.ZodNumber;
+        marginPercent: z.ZodNullable<z.ZodNumber>;
+        varianceCents: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type TravelerProfitabilityReport = z.infer<typeof travelerProfitabilityReportSchema>;
+export declare const departureProfitabilityResponse: z.ZodObject<{
+    data: z.ZodObject<{
+        rows: z.ZodArray<z.ZodObject<{
+            departureId: z.ZodString;
+            departureLabel: z.ZodNullable<z.ZodString>;
+            productId: z.ZodNullable<z.ZodString>;
+            productName: z.ZodNullable<z.ZodString>;
+            departureDate: z.ZodNullable<z.ZodString>;
+            currency: z.ZodString;
+            revenueCents: z.ZodNumber;
+            actualCostCents: z.ZodNumber;
+            plannedCostCents: z.ZodNumber;
+            profitCents: z.ZodNumber;
+            marginPercent: z.ZodNullable<z.ZodNumber>;
+            varianceCents: z.ZodNumber;
+        }, z.core.$strip>>;
+        costByServiceType: z.ZodArray<z.ZodObject<{
+            serviceType: z.ZodString;
+            currency: z.ZodString;
+            amountCents: z.ZodNumber;
+        }, z.core.$strip>>;
+        unattributed: z.ZodArray<z.ZodObject<{
+            currency: z.ZodString;
+            amountCents: z.ZodNumber;
+        }, z.core.$strip>>;
+        base: z.ZodOptional<z.ZodObject<{
+            currency: z.ZodString;
+            rows: z.ZodArray<z.ZodObject<{
+                departureId: z.ZodString;
+                departureLabel: z.ZodNullable<z.ZodString>;
+                productId: z.ZodNullable<z.ZodString>;
+                productName: z.ZodNullable<z.ZodString>;
+                departureDate: z.ZodNullable<z.ZodString>;
+                currency: z.ZodString;
+                revenueCents: z.ZodNumber;
+                actualCostCents: z.ZodNumber;
+                plannedCostCents: z.ZodNumber;
+                profitCents: z.ZodNumber;
+                marginPercent: z.ZodNullable<z.ZodNumber>;
+                varianceCents: z.ZodNumber;
+            }, z.core.$strip>>;
+            costByServiceType: z.ZodArray<z.ZodObject<{
+                serviceType: z.ZodString;
+                currency: z.ZodString;
+                amountCents: z.ZodNumber;
+            }, z.core.$strip>>;
+            unattributedCents: z.ZodNumber;
+            unconvertibleCurrencies: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const productProfitabilityResponse: z.ZodObject<{
+    data: z.ZodObject<{
+        rows: z.ZodArray<z.ZodObject<{
+            productId: z.ZodString;
+            productName: z.ZodNullable<z.ZodString>;
+            currency: z.ZodString;
+            departureCount: z.ZodNumber;
+            revenueCents: z.ZodNumber;
+            actualCostCents: z.ZodNumber;
+            plannedCostCents: z.ZodNumber;
+            profitCents: z.ZodNumber;
+            marginPercent: z.ZodNullable<z.ZodNumber>;
+            varianceCents: z.ZodNumber;
+        }, z.core.$strip>>;
+        costByServiceType: z.ZodArray<z.ZodObject<{
+            serviceType: z.ZodString;
+            currency: z.ZodString;
+            amountCents: z.ZodNumber;
+        }, z.core.$strip>>;
+        unattributed: z.ZodArray<z.ZodObject<{
+            currency: z.ZodString;
+            amountCents: z.ZodNumber;
+        }, z.core.$strip>>;
+        base: z.ZodOptional<z.ZodObject<{
+            currency: z.ZodString;
+            rows: z.ZodArray<z.ZodObject<{
+                productId: z.ZodString;
+                productName: z.ZodNullable<z.ZodString>;
+                currency: z.ZodString;
+                departureCount: z.ZodNumber;
+                revenueCents: z.ZodNumber;
+                actualCostCents: z.ZodNumber;
+                plannedCostCents: z.ZodNumber;
+                profitCents: z.ZodNumber;
+                marginPercent: z.ZodNullable<z.ZodNumber>;
+                varianceCents: z.ZodNumber;
+            }, z.core.$strip>>;
+            costByServiceType: z.ZodArray<z.ZodObject<{
+                serviceType: z.ZodString;
+                currency: z.ZodString;
+                amountCents: z.ZodNumber;
+            }, z.core.$strip>>;
+            unattributedCents: z.ZodNumber;
+            unconvertibleCurrencies: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const travelerProfitabilityResponse: z.ZodObject<{
+    data: z.ZodObject<{
+        departureId: z.ZodString;
+        currency: z.ZodString;
+        travelerCount: z.ZodNumber;
+        rows: z.ZodArray<z.ZodObject<{
+            travelerId: z.ZodString;
+            travelerName: z.ZodString;
+            bookingId: z.ZodString;
+            currency: z.ZodString;
+            revenueCents: z.ZodNumber;
+            actualCostCents: z.ZodNumber;
+            plannedCostCents: z.ZodNumber;
+            profitCents: z.ZodNumber;
+            marginPercent: z.ZodNullable<z.ZodNumber>;
+            varianceCents: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+//# sourceMappingURL=profitability.d.ts.map

package/dist/schemas/profitability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profitability.d.ts","sourceRoot":"","sources":["../../src/schemas/profitability.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB,eAAO,MAAM,oCAAoC;;;;iBAI/C,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAA;AAEjG,eAAO,MAAM,+BAA+B;;;iBAG1C,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAEvF,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;iBAa1C,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAEvF,eAAO,MAAM,sCAAsC;;;;;;;;;;;;;;;;;;;;;;;iBAMjD,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,sCAAsC,CAC9C,CAAA;AAED,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAK7C,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAE7F,eAAO,MAAM,6BAA6B;;;;;;;;;;;iBAWxC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AAEnF,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;;;;;;;iBAM/C,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAA;AAEjG,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAK3C,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AAEzF,eAAO,MAAM,8BAA8B;;;;;;;;;;;iBAWzC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAErF,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;iBAK5C,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA;AAE3F,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAqD,CAAA;AAChG,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAmD,CAAA;AAC5F,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;iBAAoD,CAAA"}

package/dist/schemas/profitability.js

@@ -0,0 +1,84 @@
+import { z } from "zod";
+import { singleEnvelope } from "./common.js";
+export const profitabilityCostByServiceTypeSchema = z.object({
+    serviceType: z.string(),
+    currency: z.string(),
+    amountCents: z.number().int(),
+});
+export const profitabilityUnattributedSchema = z.object({
+    currency: z.string(),
+    amountCents: z.number().int(),
+});
+export const departureProfitabilityRowSchema = z.object({
+    departureId: z.string(),
+    departureLabel: z.string().nullable(),
+    productId: z.string().nullable(),
+    productName: z.string().nullable(),
+    departureDate: z.string().nullable(),
+    currency: z.string(),
+    revenueCents: z.number().int(),
+    actualCostCents: z.number().int(),
+    plannedCostCents: z.number().int(),
+    profitCents: z.number().int(),
+    marginPercent: z.number().nullable(),
+    varianceCents: z.number().int(),
+});
+export const departureProfitabilityBaseRollupSchema = z.object({
+    currency: z.string(),
+    rows: z.array(departureProfitabilityRowSchema),
+    costByServiceType: z.array(profitabilityCostByServiceTypeSchema),
+    unattributedCents: z.number().int(),
+    unconvertibleCurrencies: z.array(z.string()),
+});
+export const departureProfitabilityReportSchema = z.object({
+    rows: z.array(departureProfitabilityRowSchema),
+    costByServiceType: z.array(profitabilityCostByServiceTypeSchema),
+    unattributed: z.array(profitabilityUnattributedSchema),
+    base: departureProfitabilityBaseRollupSchema.optional(),
+});
+export const productProfitabilityRowSchema = z.object({
+    productId: z.string(),
+    productName: z.string().nullable(),
+    currency: z.string(),
+    departureCount: z.number().int(),
+    revenueCents: z.number().int(),
+    actualCostCents: z.number().int(),
+    plannedCostCents: z.number().int(),
+    profitCents: z.number().int(),
+    marginPercent: z.number().nullable(),
+    varianceCents: z.number().int(),
+});
+export const productProfitabilityBaseRollupSchema = z.object({
+    currency: z.string(),
+    rows: z.array(productProfitabilityRowSchema),
+    costByServiceType: z.array(profitabilityCostByServiceTypeSchema),
+    unattributedCents: z.number().int(),
+    unconvertibleCurrencies: z.array(z.string()),
+});
+export const productProfitabilityReportSchema = z.object({
+    rows: z.array(productProfitabilityRowSchema),
+    costByServiceType: z.array(profitabilityCostByServiceTypeSchema),
+    unattributed: z.array(profitabilityUnattributedSchema),
+    base: productProfitabilityBaseRollupSchema.optional(),
+});
+export const travelerProfitabilityRowSchema = z.object({
+    travelerId: z.string(),
+    travelerName: z.string(),
+    bookingId: z.string(),
+    currency: z.string(),
+    revenueCents: z.number().int(),
+    actualCostCents: z.number().int(),
+    plannedCostCents: z.number().int(),
+    profitCents: z.number().int(),
+    marginPercent: z.number().nullable(),
+    varianceCents: z.number().int(),
+});
+export const travelerProfitabilityReportSchema = z.object({
+    departureId: z.string(),
+    currency: z.string(),
+    travelerCount: z.number().int(),
+    rows: z.array(travelerProfitabilityRowSchema),
+});
+export const departureProfitabilityResponse = singleEnvelope(departureProfitabilityReportSchema);
+export const productProfitabilityResponse = singleEnvelope(productProfitabilityReportSchema);
+export const travelerProfitabilityResponse = singleEnvelope(travelerProfitabilityReportSchema);