@hubs101/booking-api-skd-client
Version:
Package for easy access to Event App API
202 lines (138 loc) • 5.43 kB
Markdown
# hubs101-booking-api-skd-client
### API
### `getPublicTicketDetails({baseUrl, id, access})`
- `baseUrl` (`string`, required)
- `id` (`string`, required)
- `access` (`string`, required)
- returns `Promise<BookingDetails>`
### `assignTicketTo({baseUrl, id, access, reference, assignee})`
- `baseUrl` (`string`, required)
- `id` (`string`, required)
- `access` (`string`, required)
- `reference` (`string`, required)
- `assignee` (`AssigneeInput`, required)
- returns `Promise<Booking>`
### `getPublicEvents({baseUrl, page, slug, language})`
- `baseUrl` (`string`, required)
- `page` (`string`)
- `slug` (`string`)
- `language` (`string`, required)
- returns `Promise<Array<PublicEvent>>`
### `getPublicAgenda({baseUrl, page, eventId, language})`
- `baseUrl` (`string`, required)
- `page` (`string`)
- `eventId` (`string`)
- `language` (`string`, required)
- returns `Promise<CustomResponseType2<AgendaItem[]>>`
### `getPublicEventExhibitions({baseUrl, page, eventId, language})`
- `baseUrl` (`string`, required)
- `page` (`string`)
- `eventId` (`string`)
- `language` (`string`, required)
- returns `Promise<Array<PublicExhibitionItem[]>>`
### `getPublicTickets({baseUrl, page, ticketCode, eventSlug, language})`
- `baseUrl` (`string`, required)
- `page` (`string`)
- `ticketCode` (`string`)
- `eventSlug` (`string`)
- `language` (`string`, required)
- returns `Promise<ResponsePaginationType<unknown>>`
### `getTicketByCode({baseUrl, code})`
- `baseUrl` (`string`, required)
- `code` (`string`, required)
- returns `Promise<ResponsePaginationType<unknown>>`
### `getTicketById({baseUrl, id})`
- `baseUrl` (`string`, required)
- `id` (`string`, required)
- returns `Promise<{tickets: unknown}>`
### `getParamsTicket({baseUrl, params})`
- `baseUrl` (`string`, required)
- `params` (`string`, required)
- returns `Promise<Ticket>`
### `checkDiscountTicket({baseUrl, ticketsIds, discountCode, language, eventId})`
- `baseUrl` (`string`, required)
- `ticketsIds` (`string[]`, required)
- `discountCode` (`string`, required)
- `language` (`string`, required)
- `eventId` (`string`, required)
- returns `Promise<{discount:any}>`
### `getPublicPaymentMethods({baseUrl, id, language})`
- `baseUrl` (`string`, required)
- `id` (`string`, required)
- `language` (`string`, required)
- returns `Promise<ResponsePaginationType<unknown>>`
### `postPublicBookingsCheck({baseUrl, bookingCheck, language})`
- `baseUrl` (`string`, required)
- `bookingCheck` (`PublicBookingsCheckInput`, required)
- `language` (`string`, required)
- returns `Promise<ResponsePaginationType<unknown>>`
### `postPublicBookings({baseUrl, bookingCheck, language})`
- `baseUrl` (`string`, required)
- `bookingCheck` (`PublicBookingsCheckInput`, required)
- `language` (`string`, required)
- returns `Promise<ResponsePaginationType<unknown>>`
### `getPublicTicketGroupsByEvent({baseUrl, eventId, language})`
- `baseUrl` (`string`, required)
- `eventId` (`string`, required)
- `language` (`string`, required)
- returns `Promise<ResponsePaginationType<unknown>>`
### `getPublicPortfoliosByAccount({baseUrl, page, accountId, portfolioId})`
- `baseUrl` (`string`, required)
- `accountId` (`string`, required)
- `page` (`string`)
- `portfolioId` (`string`)
- returns `Promise<ResponsePaginationType<Portfolio>>`
### `getPublicBlogsByAccount({baseUrl, page, accountId, blogId})`
- `baseUrl` (`string`, required)
- `accountId` (`string`, required)
- `page` (`number`)
- `limit` (`number`)
- `tags` (`string`)
- `search` (`string`)
- returns `Promise<ResponsePaginationType<any>>`
### `getPublicEventDetailsById({baseUrl, eventId})`
- `baseUrl` (`string`, required)
- `eventId` (`string`, required)
- returns `Promise<PublicEventDetails>`
### `getPublicEventDetailsBySlug({baseUrl, eventSlug})`
- `baseUrl` (`string`, required)
- `eventSlug` (`string`, required)
- returns `Promise<PublicEventDetails>`
### `getPublicPortfolioEvents({baseUrl, accountId, portfolioSlug })`
- `baseUrl` (`string`, required)
- `accountId` (`string`, required)
- `portfolioSlug` (`string`, required)
### `getPublicEventPageDetailsBySlug({baseUrl, eventId, pageSlug })`
- `baseUrl` (`string`, required)
- `eventId` (`string`, required)
- `pageSlug` (`string`, required)
- returns `Page`
### `getPublicGroupDetailsById({baseUrl, groupId })`
- `baseUrl` (`string`, required)
- `groupId,` (`string`, required)
- returns `Group`
### `getPublicCoLocatedEventsByEventId({baseUrl, eventId })`
- `baseUrl` (`string`, required)
- `eventId,` (`string`, required)
- returns `PublicEventDetailsResponse[]`
### `postVisitor({visitorData })`
- `visitorData,` (VisitorDataInput, required)
- returns `Promise<VisitorDetails>`
### `postInbound({inboundData, secret })`
- `inboundData,` (InboundData, required)
- `secret,` (string, required)
- returns `CustomResponseType3`
### `getVisitor({visitorId, secret })`
- `visitorId,` (string, required)
- `secret,` (string, required)
- returns Promise<VisitorDetails>
### `getPublicExhibitionGroupsByCategory({baseUrl, eventId, category })`
- `baseUrl` (`string`, required)
- `eventId` (`string`, required)
- `category` (`string`, required)
- returns `Promise<CustomResponseType2<any[]>>`
### `getPublicSpeakersGroupsByCategory({baseUrl, eventId, category })`
- `baseUrl` (`string`, required)
- `eventId` (`string`, required)
- `category` (`string`, required)
- returns `Promise<CustomResponseType2<any[]>>`