UNPKG

@lyxa.ai/types

Version:

Lyxa type definitions and validation schemas for both frontend and backend

693 lines (692 loc) 20.7 kB
export declare enum AccountType { USER = "user", SHOP = "shop", RIDER = "rider", COMPANY = "company", VENDOR = "vendor", PROFESSIONAL = "professional" } export declare enum Status { ACTIVE = "active", INACTIVE = "inactive" } export declare enum ItemType { FOOD = "food", GROCERY = "grocery", PHARMACY = "pharmacy", COFFEE = "coffee", FLOWER = "flower", PET = "pet", HEALTHY_CORNER = "healthy_corner" } export declare enum GlobalItemType { GROCERY = "grocery" } export declare enum WeekDay { Sunday = 0, Monday = 1, Tuesday = 2, Wednesday = 3, Thursday = 4, Friday = 5, Saturday = 6 } export declare enum WorkStatus { OPEN = "open", CLOSED = "closed", FULL_DAY = "full_day" } export declare enum HolidayWorkStatus { CLOSED = "closed", FULL_DAY = "full_day" } export declare enum ValueType { PERCENTAGE = "percentage", FIXED = "fixed" } export declare enum PaymentMethod { CASH = "cash", ONLINE = "online" } export declare enum PaymentStatus { PAID = "paid", PENDING = "pending", FAILED = "failed", REFUNDED = "refunded", PARTIALLY_REFUNDED = "partially_refunded" } export declare enum PaidCurrency { BASE = "base", SECONDARY = "secondary", MIXED = "mixed" } export declare enum SubscriptionPackage { MONTHLY = "monthly", YEARLY = "yearly" } export declare enum SubscriptionStatus { ONGOING = "ongoing", EXPIRED = "expired" } export declare enum RatingAccountType { SHOP = "shop", RIDER = "rider" } export declare enum GeoLocationType { POINT = "Point" } export declare enum UpdatedField { MAX_TOTAL_EST_ITEMS_PRICE = "max_total_est_items_price", MAX_DISTANCE = "max_distance", DAILY_WORKING_HOURS = "daily_working_hours", BOB_CASH_SETTLEMENT_LIMIT = "bob_cash_settlement_limit", TIPS = "tips", EQUIPMENTS = "equipments", MONTHLY_SHOP_TARGET = "monthly_shop_target", MONTHLY_REWARD_PRIZE = "monthly_reward_prize", BASE_CURRENCY = "base_currency", SECONDARY_CURRENCY = "secondary_currency", IS_DUAL_CURRENCY_ENABLED = "is_dual_currency_enabled", EXCHANGE_RATE = "exchange_rate", ISSUANCE_DAY = "issuance_day", OVER_DUE_PERIODS = "over_due_periods", PAY_LIMIT_FOR_USER = "pay_limit_for_user", VAT_PERCENTAGE = "vat_percentage", RIDER_SEARCH_RANGES = "rider_search_ranges", NEAR_BY_SHOP_DISTANCE = "near_by_shop_distance", NEAR_BY_SHOP_DISTANCE_IN_HOME_SCREEN = "near_by_shop_distance_in_home_screen", UNITS = "units", CURRENCY_SETTING = "currency_setting", PAYMENT_METHODS = "payment_methods", IS_GROUND_ORDER_ENABLED = "is_ground_order_enabled", CUSTOMER_SUPPORT_PHONE_NUMBER = "customer_support_phone_number" } export declare enum AdminLogsUpdatedFieldsType { CHARGE_SETTINGS = "charge_settings", SERVICE_FEE_SETTINGS = "service_fee_settings", PAYOUT_SETTINGS = "payout_settings", COURIER_SETTINGS = "courier_settings", RIDER_SETTINGS = "rider_settings", BUSINESS_DEVELOPMENT_EXECUTIVE = "business_development_executive", PAY_LIMIT_FOR_USER = "pay_limit_for_user", VAT_PERCENTAGE = "vat_percentage", RIDER_SEARCH_RANGES = "rider_search_ranges", RIDER_BATCHES = "rider_batches", NEARBY_SHOP_DISTANCE = "nearby_shop_distance", NEAR_BY_SHOP_DISTANCE_IN_HOME_SCREEN = "nearby_shop_distance_in_home_screen", UNITS = "units", CURRENCY_SETTING = "currency_setting", PAYMENT_METHODS = "payment_methods", IS_GROUPED_ORDER_ENABLED = "is_grouped_order_enabled", CUSTOMER_SUPPORT = "customer_support", CUSTOMER_SUPPORT_BATCHES = "customer_support_batches", WORK_HOUR_SETTINGS = "work_hour_settings", PLUS_SETTING = "plus_setting", DELIVERY_CHARGES = "delivery_charges", SETTINGS_DELETED = "settings_deleted", SHOP_ACTIVATED = "shop_activated", SHOP_DEACTIVATED = "shop_deactivated", SHOP_DELETED = "shop_deleted", SHOW_SHOP_IN_USER_APP = "show_shop_in_user_app", HIDE_SHOP_IN_USER_APP = "hide_shop_in_user_app", PARENT_ACTIVATED = "parent_activated", PARENT_DEACTIVATED = "parent_deactivated", PARENT_DELETED = "parent_deleted", RIDER_CREATED = "rider_created", RIDER_UPDATED = "rider_updated", RIDER_ACTIVATED = "rider_activated", RIDER_DEACTIVATED = "rider_deactivated", RIDER_DELETED = "rider_deleted", ACTIVATED_MARKETING_PROMOTIONS = "activated_marketing_promotions", CONTINUED_MARKETING_PROMOTIONS = "continued_marketing_promotions", EDITED_MARKETING_PROMOTIONS = "edited_marketing_promotions", PAUSED_MARKETING_PROMOTIONS = "paused_marketing_promotions", DELETED_MARKETING_PROMOTIONS = "deleted_marketing_promotions", ACTIVATED_ZONE = "activated_zone", DEACTIVATED_ZONE = "deactivated_zone", CREATED_MARKETING_SETTINGS = "created_marketing_settings", CHANGE_IN_MARKETING_SETTINGS = "change_in_marketing_settings", DELETED_MARKETING_SETTINGS = "deleted_marketing_settings", CHANGE_IN_PRIVACY_POLICY = "change_in_privacy_policy", CHANGE_IN_USER_TERMS_AND_CONDITIONS = "change_in_user_terms_and_conditions", CHANGE_IN_SHOP_TERMS_AND_CONDITIONS = "change_in_shop_terms_and_conditions", CHANGE_IN_RIDER_TERMS_AND_CONDITIONS = "change_in_rider_terms_and_conditions", CHANGE_IN_LYXA_PLUS_TERMS_AND_CONDITIONS = "lyxa_plux_terms_and_conditions", CHANGE_IN_SUPPORT_REASON = "change_in_support_reason", DELETE_SUPPORT_REASON = "delete_support_reason", CHANGE_IN_CANCELLATION_REASON = "change_in_cancellation_reason", DELETE_CANCELLATION_REASON = "delete_cancellation_reason", CHANGE_IN_SETTINGS_OPENING_HOURS = "change_in_settings_opening_hours", CHANGE_IN_DEFAULT_CHAT_MESSAGE = "change_in_default_chat_messages", DELETE_DEFAULT_CHAT_MESSAGE = "delete_default_chat_message", CHANGE_IN_LYXA_PLUS_CONFIGURATION = "change_in_lyxa_plux_configuration", CHANGE_IN_BANNER_DISPLAY = "change_in_banner_display", CHANGE_IN_TAG_DISPLAY = "change_in_tag_display", CHANGE_IN_LIST_CONTAINER_DISPLAY = "change_in_list_container_display", CHANGE_IN_FILTER_CONTAINER_DISPLAY = "change_in_filter_container_display", CHANGE_IN_USER_APP_SECTIONS_DISPLAY = "change_in_user_app_sections_display", CHANGE_IN_FEATURED_SHOP_DISPLAY = "change_in_featured_shop_display", DELETE_BANNER_DISPLAY = "delete_banner_display", DELETE_TAG_DISPLAY = "delete_tag_display", DELETE_LIST_CONTAINER_DISPLAY = "delete_list_container_display", DELETE_FILTER_CONTAINER_DISPLAY = "delete_filter_container_display", DELETE_USER_APP_SECTION_DISPLAY = "delete_user_app_section_display", DELETE_FEATURED_SHOP_DISPLAY = "delete_featured_shop_display" } export declare enum UserAppSectionType { SHOW_ALL = "show_all", STORE_PUNCHES = "store_punches", AUTHENTIC_BEIRUT = "authentic_beirut", CRAZY_OFFER_SHOPS = "crazy_offer_shops", NEAR_ME = "near_me", NEARBY_FOOD = "nearby_food", NEARBY_GROCERY = "nearby_grocery", NEARBY_PET = "nearby_pet", NEARBY_FLOWER = "nearby_flower", NEARBY_COFFEE = "nearby_coffee", OFFERS = "offers", OFFERS_FOOD = "offers_food", OFFERS_GROCERY = "offers_grocery", OFFERS_PET = "offers_pet", OFFERS_FLOWER = "offers_flower", OFFERS_COFFEE = "offers_coffee", FREE_DELIVERY = "free_delivery", FREE_DELIVERY_FOOD = "free_delivery_food", FREE_DELIVERY_GROCERY = "free_delivery_grocery", FREE_DELIVERY_PET = "free_delivery_pet", FREE_DELIVERY_FLOWER = "free_delivery_flower", FREE_DELIVERY_COFFEE = "free_delivery_coffee", ORDER_AGAIN = "order_again", ORDER_AGAIN_FOOD = "order_again_food", ORDER_AGAIN_GROCERY = "order_again_grocery", ORDER_AGAIN_PET = "order_again_pet", ORDER_AGAIN_FLOWER = "order_again_flower", ORDER_AGAIN_COFFEE = "order_again_coffee", TOP_PICKS = "top_picks", TOP_PICKS_FOOD = "top_picks_food", TOP_PICKS_GROCERY = "top_picks_grocery", TOP_PICKS_PET = "top_picks_pet", TOP_PICKS_FLOWER = "top_picks_flower", TOP_PICKS_COFFEE = "top_picks_coffee" } export declare enum UserAppSectionItemType { HOME = "home", FOOD = "food", GROCERY = "grocery", COFFEE = "coffee", PET = "pet", FLOWER = "flower" } export declare enum CoreAuthIdentityType { EMAIL = "email", PHONE = "phone", GOOGLE = "google", APPLE = "apple" } export declare enum ProductType { MEAT = "meat", CHICKEN = "chicken", FISH = "fish", VEGETARIAN = "vegetarian", OTHER = "other" } export declare enum PriceOption { SINGLE_PRICE = "single_price", PRICE_PER_UNIT = "price_per_unit", PRICE_PER_PORTION = "price_per_portion" } export declare enum ProductDietaryType { GLUTEN_FREE = "gluten_free", LOW_CAL = "low_cal", VEGETARIAN = "vegetarian", VEGAN = "vegan", KETO = "keto", LACTOSE_FREE = "lactose_free", HIGH_PROTEIN = "high_protein" } export declare enum DishCategory { BREAKFAST = "breakfast", LUNCH = "lunch", DINNER = "dinner", SNACKS = "snacks" } export declare enum NotificationAccountType { USER = "user", PARENT = "parent", SHOP = "shop", RIDER = "rider", ADMIN = "admin", CUSTOMER_SERVICE = "customer_service" } export declare enum ClickType { CLICKABLE_URL = "clickable_url", CLICKABLE_ORDER = "clickable_order", CLICKABLE_SHOP = "clickable_shop", CLICKABLE_PRODUCT = "clickable_product", CLICKABLE_LIST_CONTAINER = "clickable_list_container", CLICKABLE_PAYOUT = "clickable_payout", CLICKABLE_BOB_FINANCE = "clickable_bob_finance", CLICKABLE_REQUEST_AREA = "clickable_request_area" } export declare enum ChargeType { CUSTOM = "custom" } export declare enum ShopOnlineStatus { ONLINE = "online", OFFLINE = "offline", BUSY = "busy" } export declare enum OnlineStatus { ONLINE = "online", OFFLINE = "offline" } export declare enum ShopRole { PARENT = "parent", PARENT_MANAGER = "parent_manager", PARENT_ORDER_MANAGER = "parent_order_manager", SHOP = "shop", SHOP_MANAGER = "shop_manager", SHOP_ORDER_MANAGER = "shop_order_manager" } export declare enum VendorRole { PARENT = "parent", PARENT_MANAGER = "parent_manager", PARENT_ORDER_MANAGER = "parent_order_manager", VENDOR = "vendor", VENDOR_MANAGER = "vendor_manager", VENDOR_ORDER_MANAGER = "vendor_order_manager" } export declare enum BannerClickType { LINK = "link", SHOP = "shop", PRODUCT = "product", LIST_CONTAINER = "list_container", PLUS = "plus" } export declare enum BannerLinkType { URL = "url", APP_ROUTE = "app-route" } export declare enum BannerUserType { ALL = "all", PLUS = "plus", NORMAL = "normal" } export declare enum CounterType { ORDER = "order", CRM_NUMBER = "crm_number", shop = "shop", PAYOUT = "payout", TICKET = "ticket" } export declare enum FaqAccountType { USER = "user", SHOP = "shop", RIDER = "rider" } export declare enum ZoneStatus { ACTIVE = "active", INACTIVE = "inactive", BUSY = "busy" } export declare enum BobAccountType { RIDER = "rider", SHOP = "shop" } export declare enum BobSettlementType { SETTLE_CASH = "settle_cash", SETTLE_PAYOUT = "settle_Payout" } export declare enum BobSettlementStatus { NOT_PAID = "not_paid", PAID = "paid", REVOKED = "revoked" } export declare enum BobModel { C2B = "C2B", B2C = "B2C" } export declare enum BobType { INWARD = "inward", OUTWARD = "outward" } export declare enum CouponType { GLOBAL = "global", INDIVIDUAL_STORE = "individual_store", INDIVIDUAL_USER = "individual_user", CUSTOM_COUPON = "custom_coupon", REFERRAL_CODE = "referral_code", REFERRAL_REWARD = "referral_reward" } export declare enum CouponExpirationReason { DURATION = "duration", SPEND_LIMIT = "spendLimit", TOTAL_ORDER_LIMIT = "totalOrderLimit" } export declare enum FavouriteType { PRODUCT = "product", SHOP = "shop" } export declare enum MarketingType { DISCOUNT = "discount", BUY1GET1 = "buy1get1", FREE_DELIVERY = "free_delivery", FEATURED = "featured", LOYALTY_POINT = "loyalty_point", PUNCH_MARKETING = "punch_marketing" } export declare enum MarketingStatus { ACTIVE = "active", PAUSED = "paused", EXPIRED = "expired", DELETED = "deleted" } export declare enum AdminRole { SUPER_ADMIN = "super_admin", GENERAL_MANAGER = "general_manager", ORDER_MANAGEMENT_MANAGER = "order_management_lead", ORDER_MANAGEMENT_AGENT = "order_management_agent", ACCOUNT_MANAGER = "account_manager", BUSINESS_DEVELOPMENT_EXECUTIVE = "business_development_executive", ACCOUNTING = "accounting", MARKETING_MANAGER = "marketing_manager" } export declare enum CartStatus { ACTIVE = "active", LOCKED = "locked", SUBMITTED = "submitted" } export declare enum PaymentPreference { PAY_FOR_EVERYONE = "pay_for_everyone", PAY_FOR_THEMSELVES = "pay_for_themselves" } export declare enum CardType { STRIPE = "stripe", AREEBA = "areeba" } export declare enum CardUserType { PARENT = "parent", ADMIN = "admin", USER = "user" } export declare enum AreebaCardStatus { PENDING = "pending", ACTIVE = "active" } export declare enum LiveStatus { ONLINE = "online", OFFLINE = "offline" } export declare enum CreatedBy { ADMIN = "admin", RIDER = "rider", SHOP = "shop" } export declare enum ShiftType { DAY = "day", NIGHT = "night" } export declare enum RiderType { SHOP_RIDER = "shop_rider", LYXA_RIDER = "lyxa_rider" } export declare enum RiderBagSize { REGULAR = "regular", LARGE = "large" } export declare enum OrderSize { SMALL = "small", MEDIUM = "medium", LARGE = "large" } export declare enum Language { EN = "en", AR = "ar" } export declare enum OrderType { REGULAR = "regular", COURIER = "courier", SHOP_COURIER = "shop_courier" } export declare enum RegularOrderStatus { SCHEDULED = "schedule", PLACED = "placed", ACCEPTED_BY_RIDER = "accepted_by_rider", PREPARING = "preparing", READY_FOR_PICKUP = "ready_to_pickup", ON_THE_WAY = "on_the_way", REPLACEMENT_DROP_AND_PICKUP = "replacement_drop_and_pickup", DELIVERED = "delivered", CANCELLED = "cancelled" } export declare enum CourierOrderStatus { SCHEDULED = "schedule", PLACED = "placed", ACCEPTED_BY_RIDER = "accepted_by_rider", ON_THE_WAY = "on_the_way", DELIVERED = "delivered", CANCELLED = "cancelled" } export declare enum ShopCourierOrderStatus { PLACED = "placed", ACCEPTED_BY_RIDER = "accepted_by_rider", ON_THE_WAY = "on_the_way", DELIVERED = "delivered", CANCELLED = "cancelled" } export declare enum CourierOrderPaymentFrom { SENDER = "sender", RECEIVER = "receiver" } export declare enum DeliveryStatus { PENDING = "pending", ACCEPTED_BY_RIDER = "accepted_by_rider", READY_FOR_PICKUP = "ready_to_pickup", ON_THE_WAY = "on_the_way", DELIVERED = "delivered", CANCELLED = "cancelled" } export declare enum CourierServiceType { DELIVERY_ONLY = "delivery_only", PURCHASE_AND_DELIVER = "purchase_and_deliver" } export declare enum RiderAssignmentStatus { REQUESTED = "requested", ASSIGNED = "assigned", REJECTED = "rejected", CANCELED = "canceled", UNASSIGNED = "unassigned" } export declare enum ZoneGeometryType { POLYGON = "Polygon" } export declare enum WorkingHourSettingsType { GLOBAL = "Global", SHOP = "Shop" } export declare enum MediaType { IMAGE = "image" } export declare enum SettlementType { ADD_CREDIT = "add_credit", REMOVE_CREDIT = "remove_credit", EXPIRED_LOYALTY_POINTS = "expired_loyalty_points", RIDER_SETTLE_CASH = "rider_settle_cash", SETTLE_VAT = "settle_vat", SETTLE_FEATURED_AMOUNT = "settle_featured_amount", SETTLE_SUBSCRIPTION_AMOUNT = "settle_subscription_amount", SETTLE_PAYOUT = "settle_payout", ORDER_REFUND = "order_refund", TOP_UP = "top_up", WALLET_TOP_UP = "wallet_top_up" } export declare enum AddRemoveCreditSettlementType { ADD_CREDIT = "add_credit", REMOVE_CREDIT = "remove_credit" } export declare enum PlusSettingsPackageType { MONTHLY = "monthly", YEARLY = "yearly", WEEKLY = "weekly" } export declare enum SupportReasonTypeEnum { ORDER = "order", ACCOUNT = "account", SHOP = "shop", FAQ = "faq" } export declare enum CancellationReasonTypeEnum { USER = "user", COURIER = "courier", SHOP = "shop", RESOLVE_CHAT = "resolve_chat", LYXA_PLUS_SUBSCRIPTION = "lyxa_plus_subscription" } export declare enum SettingsReasonStatus { ACTIVE = "active", INACTIVE = "inactive", DELETE = "delete" } export declare enum AddRemoveCreditAccountType { USER = "user", SHOP = "shop", RIDER = "rider" } export declare enum PayoutType { SHOP = "shop", RIDER = "rider" } export declare enum PayoutStatus { PAID = "paid", UNPAID = "unpaid", REVOKED = "revoked" } export declare enum LogUser { ALL = "all", USER = "user", SHOP = "shop", RIDER = "rider" } export declare enum OrderCanceledBy { USER = "user", SHOP = "shop", ADMIN = "admin" } export declare enum LateOrderReason { SHOP_PREPARATION_OVERDUE = "shop_preparation_overdue", PICKUP_OVERDUE = "pickup_overdue", DELIVERY_OVERDUE = "delivery_overdue" } export declare enum UrgentOrderReason { SHOP_INACTION = "shop_inaction", RIDER_INACTION = "rider_inaction", HIGH_VALUE_FIRST_ORDER = "high_value_first_order", ADJUSTED_ORDER_REQUEST_IGNORED = "adjusted_order_request_ignored" } export declare enum ReplacementReason { MISSING = "missing_item", WRONG = "wrong_item", OTHER = "other" } export declare enum ReplacementType { SHOP_CUSTOMER = "shop_customer", SHOP_CUSTOMER_SHOP = "shop_customer_shop" } export declare enum RewardedToTypeEnum { BUSINESS_DEVELOPMENT_EXECUTIVE = "business_development_executive", RIDER = "rider" } export declare enum TicketType { ORDER = "order", ACCOUNT = "account" } export declare enum TicketStatus { PENDING = "pending", RESOLVED = "resolved", ONGOING = "ongoing" } export declare enum UserRef { USER = "User", ADMIN = "Admin", SHOP = "Shop", RIDER = "Rider", VENDOR = "Vendor", PROFESSIONAL = "Professional" } export declare enum ChatroomType { TICKET = "ticket", DIRECT = "direct" } export declare enum SocketEventType { MESSAGE_RECEIVED = "message.received", TICKET_NOTIFICATION = "ticket.notification" } export declare enum ServiceCartStatus { ACTIVE = "active", LOCKED = "locked", SUBMITTED = "submitted" } export declare enum Service { CLEANING = "cleaning", LAUNDRY = "laundry", PEST_CONTROL = "pest_control", SALON = "salon" } export declare enum ProfessionalStatus { AVAILABLE = "available", BUSY = "busy", FULLY_BOOKED = "fully_booked" } export declare enum ServiceOrderStatus { PENDING = "pending", CONFIRMED = "confirmed", IN_PROGRESS = "in_progress", COMPLETED = "completed", CANCELLED = "cancelled", OVERDUE = "overdue" } export declare enum ServiceOrderPriority { NORMAL = "normal", URGENT = "urgent", FLAGGED = "flagged" } export declare enum ProfessionalRecurrencePattern { DAILY = "daily", WEEKLY = "weekly", MONTHLY = "monthly" } export declare enum OrderRecurrencePattern { ONETIME = "onetime", WEEKLY = "weekly", MONTHLY = "monthly" } export declare enum ProfessionalScheduleType { BLOCK = "block", ORDER = "order" } export declare enum ShopFilterSortByEnum { PRICE_LOW_TO_HIGH = "price_low_to_high", PRICE_HIGH_TO_LOW = "price_high_to_low", DELIVERY_TIME = "delivery_time", RATING = "rating" } export declare enum TRPCErrorEnum { PARSE_ERROR = "PARSE_ERROR", BAD_REQUEST = "BAD_REQUEST", INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR", UNAUTHORIZED = "UNAUTHORIZED", FORBIDDEN = "FORBIDDEN", NOT_FOUND = "NOT_FOUND", METHOD_NOT_SUPPORTED = "METHOD_NOT_SUPPORTED", TIMEOUT = "TIMEOUT", CONFLICT = "CONFLICT", NOT_IMPLEMENTED = "NOT_IMPLEMENTED", PRECONDITION_FAILED = "PRECONDITION_FAILED", PAYLOAD_TOO_LARGE = "PAYLOAD_TOO_LARGE", UNPROCESSABLE_CONTENT = "UNPROCESSABLE_CONTENT", TOO_MANY_REQUESTS = "TOO_MANY_REQUESTS", CLIENT_CLOSED_REQUEST = "CLIENT_CLOSED_REQUEST", BAD_GATEWAY = "BAD_GATEWAY", GATEWAY_TIMEOUT = "GATEWAY_TIMEOUT", SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE" }