tonightpass 0.0.259 → 0.0.261

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -2,15 +2,21 @@ import * as pathcat from 'pathcat';
2
2
  import { Query, ParamValue } from 'pathcat';
3
3
  export * from 'pathcat';
4
4
  import { Options, Response as Response$1 } from 'redaxios';
5
+ import { ValidatorConstraintInterface, ValidationArguments, ValidationOptions } from 'class-validator';
5
6
  import * as Stripe from 'stripe';
6
7
  import Stripe__default from 'stripe';
7
- import { ValidatorConstraintInterface, ValidationArguments, ValidationOptions } from 'class-validator';
8
8
  import { HealthCheckResult, HealthIndicatorResult } from '@nestjs/terminus';
9
9
 
10
10
  declare const DEFAULT_API_URL = "https://api.tonightpass.com";
11
11
 
12
12
  declare const REGEX: {
13
13
  EMAIL: RegExp;
14
+ INLINE: {
15
+ EMAIL: RegExp;
16
+ URL: RegExp;
17
+ USER_MENTION: RegExp;
18
+ ARTIST_MENTION: RegExp;
19
+ };
14
20
  NAME: RegExp;
15
21
  SLUG: RegExp;
16
22
  USERNAME: RegExp;
@@ -34,6 +40,81 @@ declare const REGEX: {
34
40
  USER_POST_MEDIA_URL: RegExp;
35
41
  };
36
42
 
43
+ type ArtistSoundcloudBadges = {
44
+ pro: boolean;
45
+ proUnlimited: boolean;
46
+ verified: boolean;
47
+ };
48
+ type ArtistSoundcloudWebProfile = {
49
+ network: string;
50
+ url: string;
51
+ title?: string;
52
+ username?: string;
53
+ };
54
+ type ArtistTrack = {
55
+ id: string;
56
+ title: string;
57
+ permalinkUrl: string;
58
+ artworkUrl?: string;
59
+ duration: number;
60
+ playbackCount: number;
61
+ likesCount: number;
62
+ genre?: string;
63
+ createdAt: string;
64
+ };
65
+ type ArtistSoundcloudData = {
66
+ permalinkUrl: string;
67
+ followersCount: number;
68
+ followingsCount: number;
69
+ trackCount: number;
70
+ playlistCount: number;
71
+ likesCount: number;
72
+ badges: ArtistSoundcloudBadges;
73
+ webProfiles: ArtistSoundcloudWebProfile[];
74
+ };
75
+ type ArtistTonightPassData = {
76
+ followersCount: number;
77
+ isFollowing: boolean;
78
+ };
79
+ type Artist = {
80
+ id: string;
81
+ username: string;
82
+ permalink: string;
83
+ fullName?: string;
84
+ city?: string;
85
+ countryCode?: string;
86
+ description?: string;
87
+ avatarUrl: string;
88
+ bannerUrl?: string;
89
+ soundcloud: ArtistSoundcloudData;
90
+ tonightpass: ArtistTonightPassData;
91
+ };
92
+ type ArtistWithTracks = Omit<Artist, "soundcloud"> & {
93
+ soundcloud: ArtistSoundcloudData & {
94
+ tracks: ArtistTrack[];
95
+ topTracks: ArtistTrack[];
96
+ };
97
+ };
98
+ type EventArtistRef = {
99
+ id: string;
100
+ permalink: string;
101
+ username: string;
102
+ };
103
+ type SearchArtistsOptions = ArrayOptions<Artist> & {
104
+ q: string;
105
+ };
106
+ type GetArtistOptions = {
107
+ trackLimit?: number;
108
+ };
109
+ type ListArtistEventsOptions = ArrayOptions<OrganizationEvent> & {
110
+ upcoming?: boolean;
111
+ };
112
+ type ArtistEndpoints = Endpoint<"GET", "/artists/search", ArrayResult<Artist>, SearchArtistsOptions> | Endpoint<"GET", "/artists/:idOrPermalink", ArtistWithTracks, GetArtistOptions> | Endpoint<"POST", "/artists/:idOrPermalink/follow", {
113
+ isFollowing: boolean;
114
+ }> | Endpoint<"DELETE", "/artists/:idOrPermalink/follow", {
115
+ isFollowing: boolean;
116
+ }> | Endpoint<"GET", "/artists/:idOrPermalink/events", ArrayResult<OrganizationEvent>, ListArtistEventsOptions>;
117
+
37
118
  declare enum UserNotificationType {
38
119
  Follow = "follow"
39
120
  }
@@ -969,6 +1050,7 @@ type OrganizationEvent = Base & {
969
1050
  location: Location$1;
970
1051
  tickets: OrganizationEventTicket[];
971
1052
  styles: OrganizationEventStyle[];
1053
+ artists: EventArtistRef[];
972
1054
  status: OrganizationEventStatus;
973
1055
  viewsCount: number;
974
1056
  sessionsCount: number;
@@ -1120,6 +1202,34 @@ type OrganizationCustomerMetadata = UserProfileMetadata & {
1120
1202
  };
1121
1203
  type OrganizationCustomersEndpoints = Endpoint<"GET", "/organizations/@:organizationSlug/customers", ArrayResult<OrganizationCustomer>, ArrayOptions<OrganizationCustomer>> | Endpoint<"GET", "/organizations/@:organizationSlug/customers/:username", OrganizationCustomer>;
1122
1204
 
1205
+ declare enum OrganizationNotificationType {
1206
+ OrganizationCreated = "organization_created",
1207
+ Follow = "follow",
1208
+ MemberInvited = "member_invited",
1209
+ MemberJoined = "member_joined",
1210
+ MemberLeft = "member_left",
1211
+ MemberRoleUpdated = "member_role_updated",
1212
+ EventCreated = "event_created",
1213
+ EventUpdated = "event_updated",
1214
+ OrderReceived = "order_received",
1215
+ PayoutCompleted = "payout_completed",
1216
+ EventMilestone = "event_milestone",
1217
+ BillingAccountConnected = "billing_account_connected"
1218
+ }
1219
+ type OrganizationNotificationBase = Base & {
1220
+ type: OrganizationNotificationType;
1221
+ isSeen: boolean;
1222
+ message?: string;
1223
+ metadata?: Record<string, unknown>;
1224
+ };
1225
+ type OrganizationNotificationWithActor = OrganizationNotificationBase & {
1226
+ actor?: UserProfile;
1227
+ };
1228
+ type OrganizationNotification = OrganizationNotificationWithActor;
1229
+ type OrganizationNotificationEndpoints = Endpoint<"GET", "/organizations/@:organizationSlug/notifications", ArrayResult<OrganizationNotification>, ArrayOptions<OrganizationNotification>> | Endpoint<"GET", "/organizations/@:organizationSlug/notifications/count", number, {
1230
+ unseen?: boolean;
1231
+ }> | Endpoint<"PUT", "/organizations/@:organizationSlug/notifications/read", void, undefined>;
1232
+
1123
1233
  type OrganizationOrder = Omit<Order, "user"> & {
1124
1234
  customer: OrganizationCustomer;
1125
1235
  };
@@ -1188,7 +1298,7 @@ declare enum OrganizationFileType {
1188
1298
  type OrganizationEndpoints = Endpoint<"GET", "/organizations/search", Organization[], {
1189
1299
  q: string;
1190
1300
  limit?: number;
1191
- }> | Endpoint<"GET", "/organizations", ArrayResult<Organization>, ArrayOptions<Organization>> | Endpoint<"GET", "/organizations/@:organizationSlug", Organization> | Endpoint<"POST", "/organizations", Organization, CreateOrganizationDto> | Endpoint<"PUT", "/organizations/@:organizationSlug", Organization, UpdateOrganizationDto> | Endpoint<"DELETE", "/organizations/@:organizationSlug", Organization, undefined> | Endpoint<"POST", "/organizations/@:organizationSlug/files/:organizationFileType", string, FormData> | Endpoint<"GET", "/organizations/@:organizationSlug/billing/account", OrganizationBillingAccount> | Endpoint<"GET", "/organizations/@:organizationSlug/billing/link", void> | Endpoint<"GET", "/organizations/@:organizationSlug/billing/balance", OrganizationBillingBalance> | Endpoint<"GET", "/organizations/@:organizationSlug/billing/pending", OrganizationBillingPendingRevenue> | Endpoint<"GET", "/organizations/@:organizationSlug/billing/dashboard", void> | OrganizationEventEndpoints | OrganizationMembersEndpoints | OrganizationAnalyticsEndpoints | OrganizationCustomersEndpoints | OrganizationOrdersEndpoints;
1301
+ }> | Endpoint<"GET", "/organizations", ArrayResult<Organization>, ArrayOptions<Organization>> | Endpoint<"GET", "/organizations/@:organizationSlug", Organization> | Endpoint<"POST", "/organizations", Organization, CreateOrganizationDto> | Endpoint<"PUT", "/organizations/@:organizationSlug", Organization, UpdateOrganizationDto> | Endpoint<"DELETE", "/organizations/@:organizationSlug", Organization, undefined> | Endpoint<"POST", "/organizations/@:organizationSlug/files/:organizationFileType", string, FormData> | Endpoint<"GET", "/organizations/@:organizationSlug/billing/account", OrganizationBillingAccount> | Endpoint<"GET", "/organizations/@:organizationSlug/billing/link", void> | Endpoint<"GET", "/organizations/@:organizationSlug/billing/balance", OrganizationBillingBalance> | Endpoint<"GET", "/organizations/@:organizationSlug/billing/pending", OrganizationBillingPendingRevenue> | Endpoint<"GET", "/organizations/@:organizationSlug/billing/dashboard", void> | OrganizationEventEndpoints | OrganizationMembersEndpoints | OrganizationAnalyticsEndpoints | OrganizationCustomersEndpoints | OrganizationNotificationEndpoints | OrganizationOrdersEndpoints;
1192
1302
 
1193
1303
  type PlaceCountry = Base & {
1194
1304
  geonameId: number;
@@ -1224,13 +1334,17 @@ type PlaceCity = Base & {
1224
1334
  citySlug: string;
1225
1335
  countrySlug: string;
1226
1336
  };
1337
+ type ListPlaceCountriesOptions = ArrayOptions<PlaceCountry> & {
1338
+ code?: string;
1339
+ };
1227
1340
  type SearchPlacesOptions = ArrayOptions<PlaceCity> & {
1228
1341
  q: string;
1342
+ countryCode?: string;
1229
1343
  };
1230
1344
  type NearbyCitiesOptions = ArrayOptions<PlaceCity> & {
1231
1345
  radius?: number;
1232
1346
  };
1233
- type PlaceEndpoints = Endpoint<"GET", "/places/countries", ArrayResult<PlaceCountry>, ArrayOptions<PlaceCountry>> | Endpoint<"GET", "/places/countries/:countrySlug", PlaceCountry> | Endpoint<"GET", "/places/countries/:countrySlug/cities", ArrayResult<PlaceCity>, ArrayOptions<PlaceCity>> | Endpoint<"GET", "/places/countries/:countrySlug/cities/:citySlug", PlaceCity | ExcludeBase<PlaceCity>> | Endpoint<"GET", "/places/countries/:countrySlug/cities/:citySlug/nearby", ArrayResult<Distance<PlaceCity>>, NearbyCitiesOptions> | Endpoint<"GET", "/places/cities", ArrayResult<PlaceCity>, ArrayOptions<PlaceCity>> | Endpoint<"GET", "/places/cities/search", ArrayResult<PlaceCity>, SearchPlacesOptions>;
1347
+ type PlaceEndpoints = Endpoint<"GET", "/places/countries", ArrayResult<PlaceCountry>, ListPlaceCountriesOptions> | Endpoint<"GET", "/places/countries/:countrySlug", PlaceCountry> | Endpoint<"GET", "/places/countries/:countrySlug/cities", ArrayResult<PlaceCity>, ArrayOptions<PlaceCity>> | Endpoint<"GET", "/places/countries/:countrySlug/cities/:citySlug", PlaceCity | ExcludeBase<PlaceCity>> | Endpoint<"GET", "/places/countries/:countrySlug/cities/:citySlug/nearby", ArrayResult<Distance<PlaceCity>>, NearbyCitiesOptions> | Endpoint<"GET", "/places/cities", ArrayResult<PlaceCity>, ArrayOptions<PlaceCity>> | Endpoint<"GET", "/places/cities/search", ArrayResult<PlaceCity>, SearchPlacesOptions>;
1234
1348
 
1235
1349
  type ProxyMediaOptions = {
1236
1350
  token: string;
@@ -1377,7 +1491,7 @@ type SSEEndpoints = Extract<Endpoints, {
1377
1491
  res: ReadableStream<infer _>;
1378
1492
  path: infer P;
1379
1493
  } ? P : never : never;
1380
- type Endpoints = ApiKeyEndpoints | AuthEndpoints | CareerEndpoints | ChannelEndpoints | ChannelMessageEndpoints | CurrenciesEndpoints | FeedEndpoints | HealthEndpoints | OrderEndpoints | OrganizationEndpoints | PlaceEndpoints | ProfileEndpoints | ProxyEndpoints | RoadmapEndpoints | SitemapEndpoints | UserEndpoints | WeatherEndpoints | WebhookEndpoints | NotificationEndpoints;
1494
+ type Endpoints = ApiKeyEndpoints | ArtistEndpoints | AuthEndpoints | CareerEndpoints | ChannelEndpoints | ChannelMessageEndpoints | CurrenciesEndpoints | FeedEndpoints | HealthEndpoints | OrderEndpoints | OrganizationEndpoints | PlaceEndpoints | ProfileEndpoints | ProxyEndpoints | RoadmapEndpoints | SitemapEndpoints | UserEndpoints | WeatherEndpoints | WebhookEndpoints | NotificationEndpoints;
1381
1495
 
1382
1496
  declare enum ApiKeyTier {
1383
1497
  PUBLIC = "public",
@@ -1511,6 +1625,12 @@ declare class CreateOrganizationIdentityDto {
1511
1625
  links?: string[];
1512
1626
  }
1513
1627
 
1628
+ declare class EventArtistDto implements EventArtistRef {
1629
+ id: string;
1630
+ permalink: string;
1631
+ username: string;
1632
+ }
1633
+
1514
1634
  type CreateOrganizationEventTicketInput = Omit<ExcludeBase<OrganizationEventTicket>, "price" | "product" | "event" | "fee"> & {
1515
1635
  price: number;
1516
1636
  };
@@ -1546,10 +1666,11 @@ declare class AtLeastOneMediaConstraint implements ValidatorConstraintInterface
1546
1666
  defaultMessage(): string;
1547
1667
  }
1548
1668
  declare function AtLeastOneMedia(validationOptions?: ValidationOptions): (object: object, propertyName: string) => void;
1549
- type CreateOrganizationEventInput = Omit<ExcludeBase<OrganizationEvent>, "slug" | "styles" | "tickets" | "organization" | "status" | "viewsCount" | "sessionsCount" | "totalViewsCount" | "averageViewsPerSessionCount" | "hypeCount" | "minPrice"> & {
1669
+ type CreateOrganizationEventInput = Omit<ExcludeBase<OrganizationEvent>, "slug" | "styles" | "tickets" | "artists" | "organization" | "status" | "viewsCount" | "sessionsCount" | "totalViewsCount" | "averageViewsPerSessionCount" | "hypeCount" | "minPrice"> & {
1550
1670
  slug?: string;
1551
1671
  styles: string[];
1552
1672
  tickets: CreateOrganizationEventTicketInput[];
1673
+ artists?: EventArtistDto[];
1553
1674
  };
1554
1675
  declare class BaseOrganizationEventDto {
1555
1676
  title: string;
@@ -1562,6 +1683,7 @@ declare class BaseOrganizationEventDto {
1562
1683
  trailers: string[];
1563
1684
  location: CreateLocationDto;
1564
1685
  styles: string[];
1686
+ artists?: EventArtistDto[];
1565
1687
  startAt: Date;
1566
1688
  endAt: Date;
1567
1689
  }
@@ -1612,6 +1734,7 @@ declare class UpdateOrganizationEventDto implements DeepPartial<CreateOrganizati
1612
1734
  location?: UpdateLocationDto;
1613
1735
  tickets?: UpdateOrganizationEventTicketDto[];
1614
1736
  styles?: string[];
1737
+ artists?: EventArtistDto[];
1615
1738
  startAt?: Date;
1616
1739
  endAt?: Date;
1617
1740
  }
@@ -1871,6 +1994,18 @@ declare const apiKeys: (client: Client) => {
1871
1994
  delete: (apiKeyId: string) => Promise<ApiKey>;
1872
1995
  };
1873
1996
 
1997
+ declare const artists: (client: Client) => {
1998
+ search: (query: Query<"/artists/search">) => Promise<ArrayResult<Artist>>;
1999
+ get: (query: Query<"/artists/:idOrPermalink">) => Promise<ArtistWithTracks>;
2000
+ follow: (query: Query<"/artists/:idOrPermalink/follow">) => Promise<{
2001
+ isFollowing: boolean;
2002
+ }>;
2003
+ unfollow: (query: Query<"/artists/:idOrPermalink/follow">) => Promise<{
2004
+ isFollowing: boolean;
2005
+ }>;
2006
+ events: (query: Query<"/artists/:idOrPermalink/events">) => Promise<ArrayResult<OrganizationEvent>>;
2007
+ };
2008
+
1874
2009
  declare const auth: (client: Client) => {
1875
2010
  signIn: (data: SignInUserDto) => Promise<AuthResponse>;
1876
2011
  signUp: (data: CreateUserDto) => Promise<AuthResponse>;
@@ -2039,6 +2174,38 @@ declare function getMinimumChargeableAmount(currency: Currency): number;
2039
2174
  * @returns Fee amount in smallest currency unit
2040
2175
  */
2041
2176
  declare function calculateTicketFee(ticketPrice: number, isFeesIncluded: boolean, stripeFees?: StripeFees, tonightPassFees?: TonightPassFees, params?: BillingParameters): number;
2177
+ /**
2178
+ * Calculate the platform fee for a ticket with currency-aware minimum commission.
2179
+ * Wraps `calculateTicketFee` with a converted minimum commission.
2180
+ *
2181
+ * @param ticketPrice - Ticket price in smallest unit (cents, yen, etc.)
2182
+ * @param isFeesIncluded - Whether fees are included in the ticket price
2183
+ * @param convertedMinimumCommission - MINIMUM_COMMISSION converted to the event's currency
2184
+ * @param stripeFees - Stripe fee configuration
2185
+ * @param params - Billing parameters (locality)
2186
+ * @returns Fee amount in smallest currency unit
2187
+ */
2188
+ declare function calculateTicketFeeWithCurrency(ticketPrice: number, isFeesIncluded: boolean, convertedMinimumCommission: number, stripeFees?: StripeFees, params?: BillingParameters): number;
2189
+ type CartTicket = {
2190
+ unitAmount: number;
2191
+ isFeesIncluded: boolean;
2192
+ quantity: number;
2193
+ };
2194
+ type OrderTotals = {
2195
+ subtotal: number;
2196
+ fees: number;
2197
+ includedFees: number;
2198
+ total: number;
2199
+ };
2200
+ /**
2201
+ * Calculate order totals from a cart of tickets.
2202
+ * Shared between frontend and backend to ensure consistent calculations.
2203
+ *
2204
+ * @param tickets - Array of tickets in the cart with unitAmount (smallest unit), isFeesIncluded, and quantity
2205
+ * @param convertedMinimumCommission - MINIMUM_COMMISSION converted to the event's currency (defaults to EUR 95 cents)
2206
+ * @returns Subtotal, fees, included fees, and total in smallest currency unit
2207
+ */
2208
+ declare function calculateOrderTotal(tickets: CartTicket[], convertedMinimumCommission?: number): OrderTotals;
2042
2209
  /**
2043
2210
  * Applies the minimum chargeable amount rule after a discount.
2044
2211
  * - If total is 0 → stays 0 (free order)
@@ -2164,17 +2331,17 @@ declare const organizations: (client: Client) => {
2164
2331
 
2165
2332
  declare const places: (client: Client) => {
2166
2333
  countries: {
2167
- getAll: (options?: ArrayOptions<PlaceCountry>) => Promise<ArrayResult<PlaceCountry>>;
2168
- get: (countrySlug: string) => Promise<PlaceCountry>;
2334
+ getAll: (query?: Query<"/places/countries">) => Promise<ArrayResult<PlaceCountry>>;
2335
+ get: (query: Query<"/places/countries/:countrySlug">) => Promise<PlaceCountry>;
2169
2336
  cities: {
2170
- getAll: (countrySlug: string, options?: ArrayOptions<PlaceCity>) => Promise<ArrayResult<PlaceCity>>;
2171
- get: (countrySlug: string, citySlug: string) => Promise<PlaceCity | ExcludeBase<PlaceCity>>;
2172
- nearby: (countrySlug: string, citySlug: string, options?: NearbyCitiesOptions) => Promise<ArrayResult<Distance<PlaceCity>>>;
2337
+ getAll: (query: Query<"/places/countries/:countrySlug/cities">) => Promise<ArrayResult<PlaceCity>>;
2338
+ get: (query: Query<"/places/countries/:countrySlug/cities/:citySlug">) => Promise<PlaceCity | ExcludeBase<PlaceCity>>;
2339
+ nearby: (query: Query<"/places/countries/:countrySlug/cities/:citySlug/nearby">) => Promise<ArrayResult<Distance<PlaceCity>>>;
2173
2340
  };
2174
2341
  };
2175
2342
  cities: {
2176
- getAll: (options?: ArrayOptions<PlaceCity>) => Promise<ArrayResult<PlaceCity>>;
2177
- search: (query: string, options?: ArrayOptions<PlaceCity>) => Promise<ArrayResult<PlaceCity>>;
2343
+ getAll: (query?: Query<"/places/cities">) => Promise<ArrayResult<PlaceCity>>;
2344
+ search: (query: Query<"/places/cities/search">) => Promise<ArrayResult<PlaceCity>>;
2178
2345
  };
2179
2346
  };
2180
2347
 
@@ -2263,6 +2430,17 @@ declare class TonightPass {
2263
2430
  update: (apiKeyId: string, data: UpdateApiKeyDto) => Promise<ApiKey>;
2264
2431
  delete: (apiKeyId: string) => Promise<ApiKey>;
2265
2432
  };
2433
+ readonly artists: {
2434
+ search: (query: pathcat.Query<"/artists/search">) => Promise<ArrayResult<Artist>>;
2435
+ get: (query: pathcat.Query<"/artists/:idOrPermalink">) => Promise<ArtistWithTracks>;
2436
+ follow: (query: pathcat.Query<"/artists/:idOrPermalink/follow">) => Promise<{
2437
+ isFollowing: boolean;
2438
+ }>;
2439
+ unfollow: (query: pathcat.Query<"/artists/:idOrPermalink/follow">) => Promise<{
2440
+ isFollowing: boolean;
2441
+ }>;
2442
+ events: (query: pathcat.Query<"/artists/:idOrPermalink/events">) => Promise<ArrayResult<OrganizationEvent>>;
2443
+ };
2266
2444
  readonly auth: {
2267
2445
  signIn: (data: SignInUserDto) => Promise<AuthResponse>;
2268
2446
  signUp: (data: CreateUserDto) => Promise<AuthResponse>;
@@ -2443,17 +2621,17 @@ declare class TonightPass {
2443
2621
  };
2444
2622
  readonly places: {
2445
2623
  countries: {
2446
- getAll: (options?: ArrayOptions<PlaceCountry>) => Promise<ArrayResult<PlaceCountry>>;
2447
- get: (countrySlug: string) => Promise<PlaceCountry>;
2624
+ getAll: (query?: pathcat.Query<"/places/countries">) => Promise<ArrayResult<PlaceCountry>>;
2625
+ get: (query: pathcat.Query<"/places/countries/:countrySlug">) => Promise<PlaceCountry>;
2448
2626
  cities: {
2449
- getAll: (countrySlug: string, options?: ArrayOptions<PlaceCity>) => Promise<ArrayResult<PlaceCity>>;
2450
- get: (countrySlug: string, citySlug: string) => Promise<PlaceCity | ExcludeBase<PlaceCity>>;
2451
- nearby: (countrySlug: string, citySlug: string, options?: NearbyCitiesOptions) => Promise<ArrayResult<Distance<PlaceCity>>>;
2627
+ getAll: (query: pathcat.Query<"/places/countries/:countrySlug/cities">) => Promise<ArrayResult<PlaceCity>>;
2628
+ get: (query: pathcat.Query<"/places/countries/:countrySlug/cities/:citySlug">) => Promise<PlaceCity | ExcludeBase<PlaceCity>>;
2629
+ nearby: (query: pathcat.Query<"/places/countries/:countrySlug/cities/:citySlug/nearby">) => Promise<ArrayResult<Distance<PlaceCity>>>;
2452
2630
  };
2453
2631
  };
2454
2632
  cities: {
2455
- getAll: (options?: ArrayOptions<PlaceCity>) => Promise<ArrayResult<PlaceCity>>;
2456
- search: (query: string, options?: ArrayOptions<PlaceCity>) => Promise<ArrayResult<PlaceCity>>;
2633
+ getAll: (query?: pathcat.Query<"/places/cities">) => Promise<ArrayResult<PlaceCity>>;
2634
+ search: (query: pathcat.Query<"/places/cities/search">) => Promise<ArrayResult<PlaceCity>>;
2457
2635
  };
2458
2636
  };
2459
2637
  readonly profiles: {
@@ -2690,4 +2868,4 @@ declare function channelsWS(options?: Partial<WebSocketClientOptions>): {
2690
2868
  client: ChannelWebSocketClient;
2691
2869
  };
2692
2870
 
2693
- export { type APIRequestOptions, type APIResponse, AcceptOrganizationMemberInvitationDto, AddParticipantDto, AddReactionDto, type AddRoadmapReactionBody, type AnalyticsOptions, type ApiKey, type ApiKeyEndpoints, ApiKeyTier, ApiKeyType, type ArrayFilterOptions, type ArrayOptions, type ArrayPaginationOptions, type ArrayResult, type ArraySortOptions, AtLeastOneMedia, AtLeastOneMediaConstraint, AtLeastOneMediaOnUpdate, AtLeastOneMediaOnUpdateConstraint, type AuthEndpoints, AuthFlow, type AuthMethod, type AuthResponse, type Base, BaseOrganizationEventDto, type BaseProfile, type BaseProfileMetadata, BillingLocality, type BillingParameters, type Body, type CacheEntry, CacheManager, type CacheOptions, type CacheStore, type CareerEndpoints, type CareersCategoriesOptions, type CareersCategory, type CareersEmploymentType, type CareersEmploymentTypesOptions, type CareersJob, CareersJobStatus, type CareersJobsOptions, type CareersOffice, type CareersOfficesOptions, CareersRemoteType, CareersWorkplaceType, type Channel, type ChannelDeleteEvent, type ChannelEndpoints, type ChannelMember, type ChannelMemberJoinEvent, type ChannelMemberLeaveEvent, ChannelMemberRole, type ChannelMessage, type ChannelMessageCreateEvent, type ChannelMessageDeleteEvent, type ChannelMessageEndpoints, type ChannelMessageReaction, type ChannelMessageReadByEntry, ChannelMessageReportReason, type ChannelMessageUpdateEvent, type ChannelParticipant, ChannelStatus, ChannelType, type ChannelUpdateEvent, ChannelWebSocketClient, type ChannelWebSocketEvent, Client, type ClientOptions, ContentOrAttachmentsConstraint, CreateApiKeyDto, CreateChannelDto, CreateChannelMessageDto, CreateLocationDto, CreateOrganizationDto, CreateOrganizationEventDto, type CreateOrganizationEventInput, CreateOrganizationEventOrderDto, CreateOrganizationEventPromoCodeDto, CreateOrganizationEventStyleDto, CreateOrganizationEventTicketDto, type CreateOrganizationEventTicketInput, CreateOrganizationIdentityDto, CreateOrganizationMemberDto, CreateOrganizationMemberInvitationLinkDto, CreateUserDto, CreateUserIdentityDto, CreateUserPostCommentDto, CreateUserPostDto, CreateUserPostRepostDto, type CurrenciesEndpoints, Currency, type CurrencyConversion, type CurrencyConversionResult, DEFAULT_API_URL, DEFAULT_BILLING_PARAMETERS, DEFAULT_STRIPE_FEES, DEFAULT_TONIGHTPASS_FEES, type DeepPartial, type Distance, type Endpoint, type Endpoints, ErrorType, type ErroredAPIResponse, type EventAnalyticsOptions, type ExchangeRates, type ExcludeBase, type ExternalContact, type ExternalOffer, type ExternalSource, type FeedEndpoints, type FeedPost, FeedType, type FileObject, type GeoPoint, GeoPointDto, type GeoSearchAggregation, GoogleOneTapDto, type Health, type HealthEndpoints, type HealthMemory, Language, type Location$1 as Location, MINIMUM_CHARGEABLE_AMOUNT, MINIMUM_CHARGE_AMOUNTS, MINIMUM_COMMISSION, MemoryCacheStore, type MemorySnapshot, type NearbyCitiesOptions, type NotificationEndpoints, OAuth2Provider, type Order, type OrderDiscount, type OrderEndpoints, type OrderItem, OrderTransferStatus, type Organization, type OrganizationAnalyticsEndpoints, type OrganizationAnalyticsOverview, type OrganizationBilling, type OrganizationBillingAccount, type OrganizationBillingBalance, type OrganizationBillingPendingRevenue, type OrganizationCustomer, type OrganizationCustomerMetadata, type OrganizationCustomersEndpoints, type OrganizationEndpoints, type OrganizationEvent, type OrganizationEventAnalytics, type OrganizationEventArrayOptions, type OrganizationEventCalendar, type OrganizationEventEndpoints, OrganizationEventFileType, type OrganizationEventNearbyOptions, type OrganizationEventOrderEndpoints, type OrganizationEventPromoCode, type OrganizationEventPromoCodeEndpoints, OrganizationEventPromoCodeType, type OrganizationEventPromoCodeValidation, type OrganizationEventRequestResponse, OrganizationEventStatus, type OrganizationEventStyle, type OrganizationEventStyleEndpoints, OrganizationEventStyleType, type OrganizationEventTicket, OrganizationEventTicketCategory, type OrganizationEventTicketEndpoints, OrganizationEventTicketType, OrganizationEventType, type OrganizationEventViewEndpoints, type OrganizationEventViewOptions, type OrganizationEventViewResult, OrganizationEventVisibilityType, OrganizationFileType, type OrganizationIdentity, type OrganizationMember, OrganizationMemberRole, OrganizationMemberRolePower, OrganizationMemberStatus, type OrganizationMembersEndpoints, type OrganizationOrder, type OrganizationOrdersEndpoints, OrganizationPayoutStatus, type OrganizationProfile, type OrganizationProfileMetadata, type OrganizationToken, OrganizationTokenType, type PathsFor, type PlaceCity, type PlaceCountry, type PlaceEndpoints, type Profile, type ProfileEndpoints, type ProfileMetadata, ProfileType, type PromisedAPIResponse, type PromisedResponse, type ProxyEndpoints, type ProxyMediaOptions, type ProxyMediaResponse, type QueryParams, REGEX, ROADMAP_REACTIONS, RecoveryDto, RecoveryResetDto, type RecoveryResponse, ReportChannelMessageDto, type Response, type ResponseFor, type RoadmapEndpoints, type RoadmapFeature, RoadmapFeatureStatus, type RoadmapReaction, type RoadmapReactionCounts, type SSEEndpoints, type SearchOrganizationEventsOptions, type SearchPlacesOptions, type SearchProfilesOptions, SignInUserDto, type SitemapCounts, type SitemapEndpoints, type StringifiedQuery, type StringifiedQueryValue, type StripeFees, type SuccessfulAPIResponse, TonightPass, TonightPassAPIError, type TonightPassFees, type TypingStartEvent, type TypingStopEvent, UpdateApiKeyDto, UpdateChannelDto, UpdateChannelMessageDto, UpdateLocationDto, UpdateOrganizationDto, UpdateOrganizationEventDto, UpdateOrganizationEventPromoCodeDto, UpdateOrganizationEventStyleDto, UpdateOrganizationEventTicketDto, UpdateOrganizationIdentityDto, UpdateOrganizationMemberDto, UpdateUserDto, UpdateUserPostCommentDto, UpdateUserPostDto, type User, type UserBooking, type UserBookingEndpoints, type UserBookingTicket, type UserBookingTicketEndpoints, type UserBookingWithoutTickets, type UserChannelCountOptions, type UserConnection, type UserConnectionClient, type UserConnectionDevice, type UserConnectionOS, type UserCustomer, type UserCustomerMetadata, type UserEndpoints, UserFileType, type UserIdentifier, type UserIdentity, UserIdentityGender, type UserNotification, type UserNotificationBase, type UserNotificationEndpoints, type UserNotificationFollow, UserNotificationType, type UserOAuthProvider, type UserPost, type UserPostComment, type UserPostCommentEndpoints, type UserPostEndpoints, type UserPostMedia, type UserPostMediaEndpoints, UserPostMediaType, type UserPostRepost, type UserPostRepostEndpoints, type UserPostViewEndpoints, type UserPostViewOptions, type UserPostViewResult, UserPostVisibility, type UserPreferences, type UserProfile, type UserProfileMetadata, UserRole, UserRolePower, type UserToken, UserTokenType, VerifyEmailConfirmDto, type VerifyEmailResponse, type WeatherEndpoints, type WeatherForecast, WebSocketClient, type WebSocketClientOptions, type WebSocketConnectOptions, type WebSocketEndpoint, type WebSocketEndpoints, type WebSocketEvent, type WebSocketEventHandler, type WebSocketOptionsFor, type WebSocketPath, type WebSocketPaths, type WebSocketPathsFor, type WebhookEndpoints, ZERO_DECIMAL_CURRENCIES, apiKeys, applyMinimumChargeableAmount, auth, buildFileFormData, calculateTicketFee, careers, channels, channelsWS, currencies, feed, fromSmallestUnit, getMinimumChargeableAmount, health, isBrowser, isMemberRoleAtLeast, isZeroDecimalCurrency, normalizeAddress, notifications, orders, organizations, places, profiles, request, roadmap, sdk, sitemaps, toSmallestUnit, users };
2871
+ export { type APIRequestOptions, type APIResponse, AcceptOrganizationMemberInvitationDto, AddParticipantDto, AddReactionDto, type AddRoadmapReactionBody, type AnalyticsOptions, type ApiKey, type ApiKeyEndpoints, ApiKeyTier, ApiKeyType, type ArrayFilterOptions, type ArrayOptions, type ArrayPaginationOptions, type ArrayResult, type ArraySortOptions, type Artist, type ArtistEndpoints, type ArtistSoundcloudBadges, type ArtistSoundcloudData, type ArtistSoundcloudWebProfile, type ArtistTonightPassData, type ArtistTrack, type ArtistWithTracks, AtLeastOneMedia, AtLeastOneMediaConstraint, AtLeastOneMediaOnUpdate, AtLeastOneMediaOnUpdateConstraint, type AuthEndpoints, AuthFlow, type AuthMethod, type AuthResponse, type Base, BaseOrganizationEventDto, type BaseProfile, type BaseProfileMetadata, BillingLocality, type BillingParameters, type Body, type CacheEntry, CacheManager, type CacheOptions, type CacheStore, type CareerEndpoints, type CareersCategoriesOptions, type CareersCategory, type CareersEmploymentType, type CareersEmploymentTypesOptions, type CareersJob, CareersJobStatus, type CareersJobsOptions, type CareersOffice, type CareersOfficesOptions, CareersRemoteType, CareersWorkplaceType, type CartTicket, type Channel, type ChannelDeleteEvent, type ChannelEndpoints, type ChannelMember, type ChannelMemberJoinEvent, type ChannelMemberLeaveEvent, ChannelMemberRole, type ChannelMessage, type ChannelMessageCreateEvent, type ChannelMessageDeleteEvent, type ChannelMessageEndpoints, type ChannelMessageReaction, type ChannelMessageReadByEntry, ChannelMessageReportReason, type ChannelMessageUpdateEvent, type ChannelParticipant, ChannelStatus, ChannelType, type ChannelUpdateEvent, ChannelWebSocketClient, type ChannelWebSocketEvent, Client, type ClientOptions, ContentOrAttachmentsConstraint, CreateApiKeyDto, CreateChannelDto, CreateChannelMessageDto, CreateLocationDto, CreateOrganizationDto, CreateOrganizationEventDto, type CreateOrganizationEventInput, CreateOrganizationEventOrderDto, CreateOrganizationEventPromoCodeDto, CreateOrganizationEventStyleDto, CreateOrganizationEventTicketDto, type CreateOrganizationEventTicketInput, CreateOrganizationIdentityDto, CreateOrganizationMemberDto, CreateOrganizationMemberInvitationLinkDto, CreateUserDto, CreateUserIdentityDto, CreateUserPostCommentDto, CreateUserPostDto, CreateUserPostRepostDto, type CurrenciesEndpoints, Currency, type CurrencyConversion, type CurrencyConversionResult, DEFAULT_API_URL, DEFAULT_BILLING_PARAMETERS, DEFAULT_STRIPE_FEES, DEFAULT_TONIGHTPASS_FEES, type DeepPartial, type Distance, type Endpoint, type Endpoints, ErrorType, type ErroredAPIResponse, type EventAnalyticsOptions, EventArtistDto, type EventArtistRef, type ExchangeRates, type ExcludeBase, type ExternalContact, type ExternalOffer, type ExternalSource, type FeedEndpoints, type FeedPost, FeedType, type FileObject, type GeoPoint, GeoPointDto, type GeoSearchAggregation, type GetArtistOptions, GoogleOneTapDto, type Health, type HealthEndpoints, type HealthMemory, Language, type ListArtistEventsOptions, type ListPlaceCountriesOptions, type Location$1 as Location, MINIMUM_CHARGEABLE_AMOUNT, MINIMUM_CHARGE_AMOUNTS, MINIMUM_COMMISSION, MemoryCacheStore, type MemorySnapshot, type NearbyCitiesOptions, type NotificationEndpoints, OAuth2Provider, type Order, type OrderDiscount, type OrderEndpoints, type OrderItem, type OrderTotals, OrderTransferStatus, type Organization, type OrganizationAnalyticsEndpoints, type OrganizationAnalyticsOverview, type OrganizationBilling, type OrganizationBillingAccount, type OrganizationBillingBalance, type OrganizationBillingPendingRevenue, type OrganizationCustomer, type OrganizationCustomerMetadata, type OrganizationCustomersEndpoints, type OrganizationEndpoints, type OrganizationEvent, type OrganizationEventAnalytics, type OrganizationEventArrayOptions, type OrganizationEventCalendar, type OrganizationEventEndpoints, OrganizationEventFileType, type OrganizationEventNearbyOptions, type OrganizationEventOrderEndpoints, type OrganizationEventPromoCode, type OrganizationEventPromoCodeEndpoints, OrganizationEventPromoCodeType, type OrganizationEventPromoCodeValidation, type OrganizationEventRequestResponse, OrganizationEventStatus, type OrganizationEventStyle, type OrganizationEventStyleEndpoints, OrganizationEventStyleType, type OrganizationEventTicket, OrganizationEventTicketCategory, type OrganizationEventTicketEndpoints, OrganizationEventTicketType, OrganizationEventType, type OrganizationEventViewEndpoints, type OrganizationEventViewOptions, type OrganizationEventViewResult, OrganizationEventVisibilityType, OrganizationFileType, type OrganizationIdentity, type OrganizationMember, OrganizationMemberRole, OrganizationMemberRolePower, OrganizationMemberStatus, type OrganizationMembersEndpoints, type OrganizationNotification, type OrganizationNotificationBase, type OrganizationNotificationEndpoints, OrganizationNotificationType, type OrganizationNotificationWithActor, type OrganizationOrder, type OrganizationOrdersEndpoints, OrganizationPayoutStatus, type OrganizationProfile, type OrganizationProfileMetadata, type OrganizationToken, OrganizationTokenType, type PathsFor, type PlaceCity, type PlaceCountry, type PlaceEndpoints, type Profile, type ProfileEndpoints, type ProfileMetadata, ProfileType, type PromisedAPIResponse, type PromisedResponse, type ProxyEndpoints, type ProxyMediaOptions, type ProxyMediaResponse, type QueryParams, REGEX, ROADMAP_REACTIONS, RecoveryDto, RecoveryResetDto, type RecoveryResponse, ReportChannelMessageDto, type Response, type ResponseFor, type RoadmapEndpoints, type RoadmapFeature, RoadmapFeatureStatus, type RoadmapReaction, type RoadmapReactionCounts, type SSEEndpoints, type SearchArtistsOptions, type SearchOrganizationEventsOptions, type SearchPlacesOptions, type SearchProfilesOptions, SignInUserDto, type SitemapCounts, type SitemapEndpoints, type StringifiedQuery, type StringifiedQueryValue, type StripeFees, type SuccessfulAPIResponse, TonightPass, TonightPassAPIError, type TonightPassFees, type TypingStartEvent, type TypingStopEvent, UpdateApiKeyDto, UpdateChannelDto, UpdateChannelMessageDto, UpdateLocationDto, UpdateOrganizationDto, UpdateOrganizationEventDto, UpdateOrganizationEventPromoCodeDto, UpdateOrganizationEventStyleDto, UpdateOrganizationEventTicketDto, UpdateOrganizationIdentityDto, UpdateOrganizationMemberDto, UpdateUserDto, UpdateUserPostCommentDto, UpdateUserPostDto, type User, type UserBooking, type UserBookingEndpoints, type UserBookingTicket, type UserBookingTicketEndpoints, type UserBookingWithoutTickets, type UserChannelCountOptions, type UserConnection, type UserConnectionClient, type UserConnectionDevice, type UserConnectionOS, type UserCustomer, type UserCustomerMetadata, type UserEndpoints, UserFileType, type UserIdentifier, type UserIdentity, UserIdentityGender, type UserNotification, type UserNotificationBase, type UserNotificationEndpoints, type UserNotificationFollow, UserNotificationType, type UserOAuthProvider, type UserPost, type UserPostComment, type UserPostCommentEndpoints, type UserPostEndpoints, type UserPostMedia, type UserPostMediaEndpoints, UserPostMediaType, type UserPostRepost, type UserPostRepostEndpoints, type UserPostViewEndpoints, type UserPostViewOptions, type UserPostViewResult, UserPostVisibility, type UserPreferences, type UserProfile, type UserProfileMetadata, UserRole, UserRolePower, type UserToken, UserTokenType, VerifyEmailConfirmDto, type VerifyEmailResponse, type WeatherEndpoints, type WeatherForecast, WebSocketClient, type WebSocketClientOptions, type WebSocketConnectOptions, type WebSocketEndpoint, type WebSocketEndpoints, type WebSocketEvent, type WebSocketEventHandler, type WebSocketOptionsFor, type WebSocketPath, type WebSocketPaths, type WebSocketPathsFor, type WebhookEndpoints, ZERO_DECIMAL_CURRENCIES, apiKeys, applyMinimumChargeableAmount, artists, auth, buildFileFormData, calculateOrderTotal, calculateTicketFee, calculateTicketFeeWithCurrency, careers, channels, channelsWS, currencies, feed, fromSmallestUnit, getMinimumChargeableAmount, health, isBrowser, isMemberRoleAtLeast, isZeroDecimalCurrency, normalizeAddress, notifications, orders, organizations, places, profiles, request, roadmap, sdk, sitemaps, toSmallestUnit, users };