@tmlmobilidade/types
Version:
186 lines (185 loc) • 7.78 kB
TypeScript
import { z } from 'zod';
export declare const SimplifiedApexOnBoardSaleSchema: z.ZodObject<Omit<{
_id: z.ZodString;
created_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
created_by: z.ZodOptional<z.ZodString>;
is_locked: z.ZodDefault<z.ZodBoolean>;
updated_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
updated_by: z.ZodOptional<z.ZodString>;
}, "is_locked"> & {
agency_id: z.ZodString;
apex_version: z.ZodString;
block_id: z.ZodNullable<z.ZodString>;
card_physical_type: z.ZodNumber;
card_serial_number: z.ZodString;
device_id: z.ZodString;
duty_id: z.ZodNullable<z.ZodString>;
is_passenger: z.ZodBoolean;
line_id: z.ZodNullable<z.ZodString>;
mac_ase_counter_value: z.ZodNumber;
mac_sam_serial_number: z.ZodNumber;
on_board_refund_id: z.ZodNullable<z.ZodString>;
pattern_id: z.ZodNullable<z.ZodString>;
payment_method: z.ZodNumber;
price: z.ZodNumber;
product_long_id: z.ZodString;
product_quantity: z.ZodNumber;
received_at: z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>;
stop_id: z.ZodNullable<z.ZodString>;
trip_id: z.ZodNullable<z.ZodString>;
validation_id: z.ZodNullable<z.ZodString>;
vehicle_id: z.ZodNullable<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
_id: string;
created_at: number & {
__brand: "UnixTimestamp";
};
updated_at: number & {
__brand: "UnixTimestamp";
};
agency_id: string;
apex_version: string;
device_id: string;
line_id: string | null;
mac_ase_counter_value: number;
mac_sam_serial_number: number;
pattern_id: string | null;
received_at: number & {
__brand: "UnixTimestamp";
};
stop_id: string | null;
trip_id: string | null;
vehicle_id: number | null;
block_id: string | null;
card_physical_type: number;
card_serial_number: string;
duty_id: string | null;
payment_method: number;
price: number;
product_long_id: string;
product_quantity: number;
validation_id: string | null;
is_passenger: boolean;
on_board_refund_id: string | null;
created_by?: string | undefined;
updated_by?: string | undefined;
}, {
_id: string;
created_at: number;
updated_at: number;
agency_id: string;
apex_version: string;
device_id: string;
line_id: string | null;
mac_ase_counter_value: number;
mac_sam_serial_number: number;
pattern_id: string | null;
received_at: number;
stop_id: string | null;
trip_id: string | null;
vehicle_id: number | null;
block_id: string | null;
card_physical_type: number;
card_serial_number: string;
duty_id: string | null;
payment_method: number;
price: number;
product_long_id: string;
product_quantity: number;
validation_id: string | null;
is_passenger: boolean;
on_board_refund_id: string | null;
created_by?: string | undefined;
updated_by?: string | undefined;
}>;
export declare const UpdateSimplifiedApexOnBoardSaleSchema: z.ZodObject<{
_id: z.ZodOptional<z.ZodString>;
created_at: z.ZodOptional<z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>>;
updated_at: z.ZodOptional<z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>>;
updated_by: z.ZodOptional<z.ZodOptional<z.ZodString>>;
agency_id: z.ZodOptional<z.ZodString>;
apex_version: z.ZodOptional<z.ZodString>;
device_id: z.ZodOptional<z.ZodString>;
line_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
mac_ase_counter_value: z.ZodOptional<z.ZodNumber>;
mac_sam_serial_number: z.ZodOptional<z.ZodNumber>;
pattern_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
received_at: z.ZodOptional<z.ZodEffects<z.ZodNumber, import("../_common/unix-timestamp.js").UnixTimestamp, number>>;
stop_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
trip_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
vehicle_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
block_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
card_physical_type: z.ZodOptional<z.ZodNumber>;
card_serial_number: z.ZodOptional<z.ZodString>;
duty_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
payment_method: z.ZodOptional<z.ZodNumber>;
price: z.ZodOptional<z.ZodNumber>;
product_long_id: z.ZodOptional<z.ZodString>;
product_quantity: z.ZodOptional<z.ZodNumber>;
validation_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
is_passenger: z.ZodOptional<z.ZodBoolean>;
on_board_refund_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
_id?: string | undefined;
created_at?: import("../_common/unix-timestamp.js").UnixTimestamp | undefined;
updated_at?: import("../_common/unix-timestamp.js").UnixTimestamp | undefined;
updated_by?: string | undefined;
agency_id?: string | undefined;
apex_version?: string | undefined;
device_id?: string | undefined;
line_id?: string | null | undefined;
mac_ase_counter_value?: number | undefined;
mac_sam_serial_number?: number | undefined;
pattern_id?: string | null | undefined;
received_at?: import("../_common/unix-timestamp.js").UnixTimestamp | undefined;
stop_id?: string | null | undefined;
trip_id?: string | null | undefined;
vehicle_id?: number | null | undefined;
block_id?: string | null | undefined;
card_physical_type?: number | undefined;
card_serial_number?: string | undefined;
duty_id?: string | null | undefined;
payment_method?: number | undefined;
price?: number | undefined;
product_long_id?: string | undefined;
product_quantity?: number | undefined;
validation_id?: string | null | undefined;
is_passenger?: boolean | undefined;
on_board_refund_id?: string | null | undefined;
}, {
_id?: string | undefined;
created_at?: number | undefined;
updated_at?: number | undefined;
updated_by?: string | undefined;
agency_id?: string | undefined;
apex_version?: string | undefined;
device_id?: string | undefined;
line_id?: string | null | undefined;
mac_ase_counter_value?: number | undefined;
mac_sam_serial_number?: number | undefined;
pattern_id?: string | null | undefined;
received_at?: number | undefined;
stop_id?: string | null | undefined;
trip_id?: string | null | undefined;
vehicle_id?: number | null | undefined;
block_id?: string | null | undefined;
card_physical_type?: number | undefined;
card_serial_number?: string | undefined;
duty_id?: string | null | undefined;
payment_method?: number | undefined;
price?: number | undefined;
product_long_id?: string | undefined;
product_quantity?: number | undefined;
validation_id?: string | null | undefined;
is_passenger?: boolean | undefined;
on_board_refund_id?: string | null | undefined;
}>;
/**
* APEX OnBoard Sales are APEX transactions of type 3 that are generated whenever a sale
* of an on-board ticket occurs. Even though sales can be of anything (tickets, cards, contracts, merchandising items)
* and anywhere (inside vehicles, at vending machines, at ticket offices or online), here they are already filtered
* for on-board ticket sales inside vehicles only. Sales of tickets when inside vehicles also generate a validation transaction.
* Sales can be refunded, and refunds are also APEX transactions of type 3.
*/
export type SimplifiedApexOnBoardSale = z.infer<typeof SimplifiedApexOnBoardSaleSchema>;
export type UpdateSimplifiedApexOnBoardSaleDto = z.infer<typeof UpdateSimplifiedApexOnBoardSaleSchema>;