@meaple-com/types

TypeScript types and DTOs for the Meaple ticketing platform SDK.

Installation

npm install @meaple-com/types
# or
pnpm add @meaple-com/types
# or
bun add @meaple-com/types

Usage

Use these types in your app or in other Meaple packages for type-safe APIs:

import type {
  EventProps,
  FindEventsParams,
  TicketProps,
  OrderProps,
  CreateOrderParams,
  CouponProps,
  UserProps,
  CategoryProps,
} from '@meaple-com/types';

Exported namespaces

• Address – AddressProps
• Category – CategoryProps, ChartCategoryProps
• Channel – ChannelProps, GetChannelEventsProps, GetChannelEventProps
• Coupon – CouponProps, CheckCouponProps
• Event – EventProps, FindEventsParams, FindEventsResponseProps, GetEventTicketsResponseProps, GetEventProductsResponseProps, EventContact, ExternalAnalyticsProps, CreateEventReminderProps
• File – FileProps, CreateTicketFileProps
• Gauge – GaugeProps
• Order – OrderProps, OrderItemProps, CreateOrderParams, CreatedOrderResponseProps, GetOrderResponseProps, BuyerProps, PaymentIntentProps, NominationProps, PlatformFeeProps
• Payment – PlatformFeeProps
• Tag – TagProps
• Ticket – TicketProps, GroupProps, UpdateUserTicketProps, TransferTicketProps, TicketCustomFieldProps
• User – UserProps, GetUserEventProps, GetUserOrdersProps
• User ticket – UserTicketProps

Peer usage

This package has no runtime code; it only provides type definitions. It is used by:

• @meaple-com/core – API client types
• @meaple-com/react-query – hook request/response types
• @meaple-com/react-headless-components – component prop types

Documentation

https://docs.meaple.com.br/