@esri/arcgis-rest-places 1.0.0

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.
Files changed (52) hide show
  1. package/README.md +89 -0
  2. package/dist/bundled/places.esm.js +217 -0
  3. package/dist/bundled/places.esm.js.map +1 -0
  4. package/dist/bundled/places.esm.min.js +7 -0
  5. package/dist/bundled/places.esm.min.js.map +1 -0
  6. package/dist/bundled/places.umd.js +229 -0
  7. package/dist/bundled/places.umd.js.map +1 -0
  8. package/dist/bundled/places.umd.min.js +7 -0
  9. package/dist/bundled/places.umd.min.js.map +1 -0
  10. package/dist/cjs/findPlacesNearPoint.js +58 -0
  11. package/dist/cjs/findPlacesNearPoint.js.map +1 -0
  12. package/dist/cjs/findPlacesWithinExtent.js +68 -0
  13. package/dist/cjs/findPlacesWithinExtent.js.map +1 -0
  14. package/dist/cjs/getCategories.js +33 -0
  15. package/dist/cjs/getCategories.js.map +1 -0
  16. package/dist/cjs/getCategory.js +27 -0
  17. package/dist/cjs/getCategory.js.map +1 -0
  18. package/dist/cjs/getPlaceDetails.js +40 -0
  19. package/dist/cjs/getPlaceDetails.js.map +1 -0
  20. package/dist/cjs/index.js +11 -0
  21. package/dist/cjs/index.js.map +1 -0
  22. package/dist/cjs/openapi-types.js +7 -0
  23. package/dist/cjs/openapi-types.js.map +1 -0
  24. package/dist/cjs/package.json +3 -0
  25. package/dist/cjs/utils.js +17 -0
  26. package/dist/cjs/utils.js.map +1 -0
  27. package/dist/esm/findPlacesNearPoint.d.ts +55 -0
  28. package/dist/esm/findPlacesNearPoint.js +54 -0
  29. package/dist/esm/findPlacesNearPoint.js.map +1 -0
  30. package/dist/esm/findPlacesWithinExtent.d.ts +56 -0
  31. package/dist/esm/findPlacesWithinExtent.js +64 -0
  32. package/dist/esm/findPlacesWithinExtent.js.map +1 -0
  33. package/dist/esm/getCategories.d.ts +38 -0
  34. package/dist/esm/getCategories.js +29 -0
  35. package/dist/esm/getCategories.js.map +1 -0
  36. package/dist/esm/getCategory.d.ts +32 -0
  37. package/dist/esm/getCategory.js +23 -0
  38. package/dist/esm/getCategory.js.map +1 -0
  39. package/dist/esm/getPlaceDetails.d.ts +45 -0
  40. package/dist/esm/getPlaceDetails.js +36 -0
  41. package/dist/esm/getPlaceDetails.js.map +1 -0
  42. package/dist/esm/index.d.ts +6 -0
  43. package/dist/esm/index.js +8 -0
  44. package/dist/esm/index.js.map +1 -0
  45. package/dist/esm/openapi-types.d.ts +1499 -0
  46. package/dist/esm/openapi-types.js +6 -0
  47. package/dist/esm/openapi-types.js.map +1 -0
  48. package/dist/esm/package.json +3 -0
  49. package/dist/esm/utils.d.ts +6 -0
  50. package/dist/esm/utils.js +12 -0
  51. package/dist/esm/utils.js.map +1 -0
  52. package/package.json +74 -0
@@ -0,0 +1,1499 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ export interface paths {
6
+ "/categories": {
7
+ /**
8
+ * A category describes a type of place, such as "movie theater" or "zoo".
9
+ * The places service has over 1,000 categories (or types) of place. The
10
+ * categories fall into ten general groups: Arts and Entertainment, Business
11
+ * and Professional Services, Community and Government, Dining and Drinking,
12
+ * Events, Health and Medicine, Landmarks and Outdoors, Retail, Sports and
13
+ * Recreation, and Travel and Transportation.
14
+ *
15
+ * There are up to four levels of categories. For example: "Travel and
16
+ * Transportation" (Level 1), "Transport Hub" (Level 2), "Airport"
17
+ * (Level 3) and "Airport Terminal" (Level 4).
18
+ *
19
+ * The table below shows the top-level of categories, along with a
20
+ * selection of level two categories.
21
+ *
22
+ * The `/categories` endpoint fetches the latest set of place categories.
23
+ * The request returns all categories including their label and
24
+ * `categoryId`. You should use this endpoint to fetch the latest set of
25
+ * categories when your app starts up. Each category contains an unique ID
26
+ * that you can use to perform a `near-point` or `within-extent` search.
27
+ *
28
+ * You can also reduce the list to a subset of categories using the
29
+ * `filter` parameter. For example, searching for "coffee" would return
30
+ * categories including:
31
+ *
32
+ * - "Coffee Shop"
33
+ *
34
+ * - "Coffee Roaster"
35
+ *
36
+ * - "Turkish Coffeehouse"
37
+ *
38
+ * |Category Label | Category ID | Level 2|
39
+ * |--- | --- | ---|
40
+ * |Arts and Entertainment | 10000 | Amusement Park (10001), Art Gallery (10004), Casino (10008), Exhibit (10016), Movie Theater (10024), Museum (10027), Stadium (10051), Water Park (10055), Zoo (10056), ...|
41
+ * |Business and Professional Services | 11000 | Construction (11028), Convention Center (11029), Food and Beverage Service (11056), Health and Beauty Service (11061), Industrial Estate (11106), Office (11124), ...|
42
+ * |Community and Government | 12000 | Education (12009), Organization (12082), Government Building (12064), Community Center (12004), Library (12080), Utility Company (12115), ...|
43
+ * |Dining and Drinking | 13000 | Bakery (13002), Bar (13003), Cafes, Coffee, and Tea House (13032), Restaurant (13065, ...|
44
+ * |Event | 14000 | Conference (14001), Convention (14002), Entertainment Event (14003), Marketplace (14009), ...|
45
+ * |Health and Medicine | 15000 | Dentist (15007), Emergency Service (15008), Hospital (15014), Medical Center (15016), Optometrist (15024), Physician (15027), Veterinarian (15054), ...|
46
+ * |Landmarks and Outdoors | 16000 | Beach (16003), Building / Structure (16007), Campground (16008), Harbor / Marina (16018), Historic and Protected Site (16020), Monument (16026), Nature Preserve (16028), Park (16032), ...|
47
+ * |Retail | 17000 | Arts and Crafts Store (17003), Bookstore (17018), Convenience Store (17029), Department Store (17033)|
48
+ * |Sports and Recreation | 18000 | Athletic Field (18001), Baseball (18002), Basketball (18006), Football (18013), Golf (18016), Gym and Studio (18021), ...|
49
+ * |Travel and Transportation | 19000 | Bike Rental (19002), Cruise (19005), Electric Vehicle Charging Station (19006), Fuel Station (19007), Lodging (19009), Transport Hub (19030), ...|
50
+ *
51
+ * **Note**: Category details are subject to change as new types of places
52
+ * are introduced.
53
+ */
54
+ get: operations["categoriesGet"];
55
+ };
56
+ "/categories/{categoryId}": {
57
+ /** The `/categories/{categoryId}` operation returns all the groups to which the category belongs. You must supply a `category ID` to use this operation. */
58
+ get: operations["categoriesCategoryIdGet"];
59
+ };
60
+ "/places/near-point": {
61
+ /**
62
+ * The `/places/near-point` operation finds places that are within a given
63
+ * radius of a specified location. The returned places contain basic data
64
+ * such as name, category and location.
65
+ *
66
+ * To perform the request, you must supply the `x` and `y` coordinates of
67
+ * the point from which to search. Optionally, you can also specify the:
68
+ *
69
+ * - Search radius (up to 10,000 meters)
70
+ * - Category IDs
71
+ * - Search text
72
+ *
73
+ * If the `maxResultsExceeded` property in the response is `true`, then you
74
+ * can page through the results to return more places. The maximum number
75
+ * of places that cane be paged to is 200.
76
+ *
77
+ * **Note**: You cannot permanently store places. Please see the [Terms of
78
+ * use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
79
+ */
80
+ get: operations["nearPointGet"];
81
+ };
82
+ "/places/within-extent": {
83
+ /**
84
+ * The `/places/within-extent` operation searches for places within an extent (bounding box).
85
+ *
86
+ * You must supply the `xmin`,
87
+ * `ymin`, `xmax` and `ymax` coordinates to define the extent. The maximum width
88
+ * and height of an extent that can be used in a search is 20,000 meters.
89
+ *
90
+ * You can also provide multiple categories or search text to find specific types of places within the extent.
91
+ *
92
+ * The default number of places returned (`pageSize`) is 10. The maximum `pageSize` value is 20.
93
+ *
94
+ * If the `maxResultsExceeded` property in the response is `true`, then you
95
+ * can page through the results to return more places. The maximum number
96
+ * of places that cane be paged to is 200.
97
+ *
98
+ * **Note**: You cannot permanently store places. Please see the [Terms of
99
+ * use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
100
+ */
101
+ get: operations["withinExtentGet"];
102
+ };
103
+ "/places/{placeId}": {
104
+ /**
105
+ * The `/places/{placeId}` operation returns details for a place.
106
+ *
107
+ * To request details, you use the `requestedFields` parameter to specify
108
+ * the fields and the attributes you want from the **Place**,
109
+ * **Address**, and/or **Details** price groups.
110
+ *
111
+ * It is always recommended to specify the fields you want, however, you
112
+ * can also use `requestedFields=all` to return all of the attributes
113
+ * available. By default, The `placeId` attribute is always returned in addition
114
+ * to the other attributes you requested.
115
+ *
116
+ * The attributes available for places may vary. For example, opening hours
117
+ * may not be available (or applicable) for geographic places or landmarks.
118
+ *
119
+ * You will only be charged for attributes that contain valid values for
120
+ * the requested fields. If no data is available for the requested field,
121
+ * `null` or an empty collection is returned and you are not charged. You are only charged once if
122
+ * one or more attributes with valid values are returned from a price
123
+ * group. To learn more, go to
124
+ * [Pricing](https://places-service-preview.sites.afd.arcgis.com/rest/places/#pricing).
125
+ *
126
+ * Field | Price group
127
+ * --- | ---
128
+ * name | Place
129
+ * categoryId | Place
130
+ * address:country | Address
131
+ * address:adminRegion | Address
132
+ * address:region | Address
133
+ * address:streetAddress | Address
134
+ * address:extended | Address
135
+ * address:poBox | Address
136
+ * address:postcode | Address
137
+ * address:postTown | Address
138
+ * address:locality | Address
139
+ * address:neighborhood | Address
140
+ * address:censusBlockId | Address
141
+ * address:designatedMarketArea | Address
142
+ * contactInfo:telephone | Details
143
+ * contactInfo:website | Details
144
+ * contactInfo:fax | Details
145
+ * contactInfo:email | Details
146
+ * socialMedia:facebookId | Details
147
+ * socialMedia:instagram | Details
148
+ * socialMedia:twitter | Details
149
+ * chains | Details
150
+ * description | Details
151
+ * rating:user | Details
152
+ * rating:price | Details
153
+ * hours:opening | Details
154
+ * hours:popular | Details
155
+ * hours:openingText | Details
156
+ *
157
+ * **Note**: You cannot permanently store places. Please see the [Terms of
158
+ * use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
159
+ */
160
+ get: operations["placeIdGet"];
161
+ };
162
+ }
163
+ export interface components {
164
+ schemas: {
165
+ /** @example 722d8e1ba4db8ec5ef256b09cf060782 */
166
+ PlaceId: string;
167
+ /**
168
+ * @description Property indicating whether the query resulted in more than `200` places.
169
+ *
170
+ * The maximum number of places that can be returned in total is `200`. If
171
+ * a request reaches this limit without returning all of the available
172
+ * places, this response property will be set to `true`.
173
+ *
174
+ * You can refine your query to reduce the number of places returned. For
175
+ * example, you could:
176
+ *
177
+ * - Search a smaller geographic area.
178
+ *
179
+ * - Use category Ids to specify the type of place you are looking for.
180
+ *
181
+ * - Supply a search text string.
182
+ *
183
+ * @example true
184
+ */
185
+ MaxResultsExceeded: boolean;
186
+ /**
187
+ * @description A result of searching for places using a `places/near-point` request.
188
+ *
189
+ * The result object includes a single place that satisfied the search and
190
+ * the distance from the search point, in meters.
191
+ */
192
+ NearPointResult: {
193
+ /**
194
+ * @description The unique Id of this place.
195
+ *
196
+ * This place Id can be passed to the `places/{placeId}` endpoint to
197
+ * retrieve additional details.
198
+ *
199
+ * @example 722d8e1ba4db8ec5ef256b09cf060782
200
+ */
201
+ placeId: components["schemas"]["PlaceId"];
202
+ /**
203
+ * @description The location of this place as a WGS84 point.
204
+ *
205
+ * @example {
206
+ * "x": -117.194769,
207
+ * "y": 34.057289
208
+ * }
209
+ */
210
+ location: components["schemas"]["Point"];
211
+ /**
212
+ * @description A list of category objects for a place.
213
+ *
214
+ * Categories are uniquely identified by a `categoryId`. For example,
215
+ * `17119` identifies a "Bicycle Store" and `10051` identifies a
216
+ * "Stadium". Note that a single place can belong to multiple
217
+ * categories (for example, a petrol station could also have a
218
+ * super-market).
219
+ *
220
+ * @example [
221
+ * {
222
+ * "categoryId": 17119,
223
+ * "label": "Bicycle Store"
224
+ * }
225
+ * ]
226
+ */
227
+ categories: components["schemas"]["Category"][];
228
+ /**
229
+ * @description The name of the place, or point of interest.
230
+ * You can search for places by name using the `searchText` property in
231
+ * a `places/near-point` or `places/within-extent` request.
232
+ *
233
+ * @example Esri International
234
+ */
235
+ name: string;
236
+ /**
237
+ * @description The distance, in meters, from the place to the search point of a 'places/near-point` query.
238
+ *
239
+ * @example 50
240
+ */
241
+ distance: number;
242
+ };
243
+ /**
244
+ * @description A result of searching for places using a `places/within-extent` request.
245
+ *
246
+ * The result object includes a single place that satisfied the search.
247
+ */
248
+ WithinExtentResult: {
249
+ /**
250
+ * @description The unique Id of this place.
251
+ *
252
+ * This place Id can be passed to the `places/{placeId}` endpoint to
253
+ * retrieve additional details.
254
+ *
255
+ * @example 722d8e1ba4db8ec5ef256b09cf060782
256
+ */
257
+ placeId: components["schemas"]["PlaceId"];
258
+ /**
259
+ * @description The location of this place as a WGS84 point.
260
+ *
261
+ * @example {
262
+ * "x": -117.194769,
263
+ * "y": 34.057289
264
+ * }
265
+ */
266
+ location: components["schemas"]["Point"];
267
+ /**
268
+ * @description A list of category objects for a place.
269
+ *
270
+ * Categories are uniquely identified by a `categoryId`. For example,
271
+ * `17119` identifies a "Bicycle Store" and `10051` identifies a
272
+ * "Stadium". Note that a single place can belong to multiple
273
+ * categories (for example, a petrol station could also have a
274
+ * super-market).
275
+ *
276
+ * @example [
277
+ * {
278
+ * "categoryId": 17119,
279
+ * "label": "Bicycle Store"
280
+ * }
281
+ * ]
282
+ */
283
+ categories: components["schemas"]["Category"][];
284
+ /**
285
+ * @description The name of the place, or point of interest.
286
+ * You can search for places by name using the `searchText` property in
287
+ * a `places/near-point` or `places/within-extent` request.
288
+ *
289
+ * @example Esri International
290
+ */
291
+ name: string;
292
+ };
293
+ /**
294
+ * @description The additional details for a `Place`, including address, contact details, opening hours, and rating.
295
+ *
296
+ * You can request additional details for a place by using the `placeId` in
297
+ * a `places/{placeId}` request. Use the `requestedFields` query parameter
298
+ * to choose the fields or attributes that are included in the response.
299
+ */
300
+ PlaceDetails: {
301
+ /**
302
+ * @description The unique Id of this place.
303
+ *
304
+ * @example 722d8e1ba4db8ec5ef256b09cf060782
305
+ */
306
+ placeId: components["schemas"]["PlaceId"];
307
+ /**
308
+ * @description A list of category objects for a place.
309
+ *
310
+ * Categories are uniquely identified by a `categoryId`. For example,
311
+ * `17119` identifies a "Bicycle Store" and `10051` identifies a
312
+ * "Stadium". Note that a single place can belong to multiple
313
+ * categories (for example, a petrol station could also have a
314
+ * super-market).
315
+ *
316
+ * This property is part of the "Place" attribute group.
317
+ *
318
+ * @example [
319
+ * {
320
+ * "categoryId": 17119,
321
+ * "label": "Bicycle Store"
322
+ * }
323
+ * ]
324
+ */
325
+ categories?: components["schemas"]["Category"][];
326
+ /**
327
+ * @description The name of the place, or point of interest.
328
+ *
329
+ * This property is part of the "Place" attribute group.
330
+ *
331
+ * @example Esri International
332
+ */
333
+ name?: string;
334
+ /**
335
+ * @description A text description of the place.
336
+ *
337
+ * This property is part of the "Details" attribute group.
338
+ *
339
+ * @example Esri is the global market leader in geographic information system
340
+ * (GIS) technology, location intelligence, mapping software, and
341
+ * spatial analytics. Esri software is deployed in more than 350,000
342
+ * organizations and 75 percent of Fortune 500 companies.
343
+ */
344
+ description?: string | null;
345
+ /**
346
+ * @description The address of the place or point of interest (POI).
347
+ *
348
+ * This object and child properties are part of the "Address" attribute
349
+ * group.
350
+ */
351
+ address?: components["schemas"]["Address"];
352
+ /**
353
+ * @description Contact information for the place, such as the telephone number or email address.
354
+ *
355
+ * This object and child properties are part of the "Details" attribute
356
+ * group.
357
+ */
358
+ contactInfo?: components["schemas"]["ContactInfo"];
359
+ /**
360
+ * @description Social media information associated with the place.
361
+ *
362
+ * This object and child properties are part of the "Details" attribute
363
+ * group.
364
+ */
365
+ socialMedia?: components["schemas"]["SocialMedia"];
366
+ /**
367
+ * @description The operating hours for the place, including hours of opening and popular times.
368
+ *
369
+ * This object and child properties are part of the "Details" attribute
370
+ * group.
371
+ */
372
+ hours?: components["schemas"]["Hours"];
373
+ /**
374
+ * @description Rating information supplied by users of the place.
375
+ *
376
+ * This object and child properties are part of the "Details" attribute
377
+ * group.
378
+ */
379
+ rating?: components["schemas"]["Rating"];
380
+ /**
381
+ * @description Information about all the chains the place belongs to.
382
+ *
383
+ * This object and child properties are part of the "Details" attribute
384
+ * group.
385
+ *
386
+ * @example [
387
+ * {
388
+ * "name": "Starbucks"
389
+ * }
390
+ * ]
391
+ */
392
+ chains?: components["schemas"]["ChainInfo"][];
393
+ };
394
+ /** @example 17119 */
395
+ CategoryId: string;
396
+ /**
397
+ * @description Represents the category of a place.
398
+ *
399
+ * You can get more information on categories from the `places/categories`
400
+ * endpoint.
401
+ */
402
+ Category: {
403
+ /**
404
+ * @description The category Id uniquely identifies this category or type of place.
405
+ *
406
+ * The name of the category can be looked up using the
407
+ * `places/categories` endpoint. For example, 17119 is the id for a
408
+ * "Bicycle Store".
409
+ *
410
+ * @example 17119
411
+ */
412
+ categoryId: components["schemas"]["CategoryId"];
413
+ /**
414
+ * @description The label that describes the category.
415
+ *
416
+ * @example Bicycle Store
417
+ */
418
+ label: string;
419
+ };
420
+ /**
421
+ * @description Provides details about a category or type of place.
422
+ *
423
+ * Categories are hierarchical so that you can filter places based on
424
+ * specific categories such as "Provençal Restaurant", or with more generic
425
+ * types such as "Restaurant". A category such as "Provençal Restaurant"
426
+ * includes the details of its more generic parent, such as "French
427
+ * Restaurant".
428
+ */
429
+ CategoryDetails: {
430
+ /**
431
+ * @description A unique identifying string for a category.
432
+ *
433
+ * This matches the `categoryId` of a place's `category` property.
434
+ *
435
+ * @example 17119
436
+ */
437
+ categoryId: components["schemas"]["CategoryId"];
438
+ /** @description The full list of labels that describe the category, including its more generic parent categories. */
439
+ fullLabel: string[];
440
+ /** @description The list of parent category Ids for this category. */
441
+ parents?: string[];
442
+ };
443
+ /**
444
+ * Format: double
445
+ * @description An x-coordinate, or longitude, in WGS84 decimal degrees.
446
+ * @example -117.194769
447
+ */
448
+ XCoord: number;
449
+ /**
450
+ * Format: double
451
+ * @description A y-coordinate, or latitude, in WGS84 decimal degrees.
452
+ * @example 34.057289
453
+ */
454
+ YCoord: number;
455
+ /**
456
+ * Format: float
457
+ * @description A search distance in meters.
458
+ *
459
+ * @default 1000
460
+ * @example 50
461
+ */
462
+ SearchDistance: number;
463
+ /**
464
+ * @description A point defined in WGS84 decimal degrees.
465
+ *
466
+ * @example {
467
+ * "x": -117.194769,
468
+ * "y": 34.057289
469
+ * }
470
+ */
471
+ Point: {
472
+ /** @description The x, or longitude, of this location in WGS84 decimal degrees. */
473
+ x: components["schemas"]["XCoord"];
474
+ /** @description The y, or latitude, of this location in WGS84 decimal degrees. */
475
+ y: components["schemas"]["YCoord"];
476
+ };
477
+ /**
478
+ * @description A point defined in WGS84 decimal degrees.
479
+ *
480
+ * @example {
481
+ * "x": -117.194769,
482
+ * "y": 34.057289
483
+ * }
484
+ */
485
+ NullablePoint: {
486
+ /** @description The x, or longitude, of this location in WGS84 decimal degrees. */
487
+ x: components["schemas"]["XCoord"];
488
+ /** @description The y, or latitude, of this location in WGS84 decimal degrees. */
489
+ y: components["schemas"]["YCoord"];
490
+ } | null;
491
+ /**
492
+ * @description A pair of times defining the start and end of a time period.
493
+ *
494
+ * For example, this could define opening hours or popular hours. Hours are
495
+ * shown in 24-hour time in the local timezone of the place or POI.
496
+ *
497
+ * Where a time range is 24-hours (for example a venue that is open 24-hours),
498
+ * the `from` property will be 00:00 and the `to` property will be 23:59.
499
+ *
500
+ * @example {
501
+ * "from": "10:00",
502
+ * "to": "13:00"
503
+ * }
504
+ */
505
+ TimeRange: {
506
+ /**
507
+ * @description The start of a time range in the format "HH:MM".
508
+ * @example 09:00
509
+ */
510
+ from: string;
511
+ /**
512
+ * @description The end of a time range in the format "HH:MM".
513
+ * @example 15:30
514
+ */
515
+ to: string;
516
+ };
517
+ /**
518
+ * @description The opening or popular hours for a place.
519
+ *
520
+ * Opening hours are shown by day of the week. Each day can have several
521
+ * pairs of from and to times. For example, if a coffee shop is open from
522
+ * 9:00 until 12:00 and then again from 13:00 until 17:00, it would contain
523
+ * two pairs of opening/closing times: 9:00 paired with 12:00 and 13:00
524
+ * with 17:00. Hours are shown in 24-hour time in the local timezone of the
525
+ * place or POI.
526
+ */
527
+ HoursByDay: {
528
+ /**
529
+ * @example [
530
+ * {
531
+ * "from": "09:00",
532
+ * "to": "17:00"
533
+ * }
534
+ * ]
535
+ */
536
+ monday?: components["schemas"]["TimeRange"][];
537
+ /**
538
+ * @example [
539
+ * {
540
+ * "from": "09:00",
541
+ * "to": "17:00"
542
+ * }
543
+ * ]
544
+ */
545
+ tuesday?: components["schemas"]["TimeRange"][];
546
+ /**
547
+ * @example [
548
+ * {
549
+ * "from": "09:00",
550
+ * "to": "12:00"
551
+ * },
552
+ * {
553
+ * "from": "13:00",
554
+ * "to": "17:00"
555
+ * }
556
+ * ]
557
+ */
558
+ wednesday?: components["schemas"]["TimeRange"][];
559
+ /**
560
+ * @example [
561
+ * {
562
+ * "from": "09:00",
563
+ * "to": "17:00"
564
+ * }
565
+ * ]
566
+ */
567
+ thursday?: components["schemas"]["TimeRange"][];
568
+ /**
569
+ * @example [
570
+ * {
571
+ * "from": "09:00",
572
+ * "to": "17:00"
573
+ * }
574
+ * ]
575
+ */
576
+ friday?: components["schemas"]["TimeRange"][];
577
+ /**
578
+ * @example [
579
+ * {
580
+ * "from": "10:00",
581
+ * "to": "17:00"
582
+ * }
583
+ * ]
584
+ */
585
+ saturday?: components["schemas"]["TimeRange"][];
586
+ /**
587
+ * @example [
588
+ * {
589
+ * "from": "11:00",
590
+ * "to": "12:00"
591
+ * }
592
+ * ]
593
+ */
594
+ sunday?: components["schemas"]["TimeRange"][];
595
+ } | null;
596
+ /**
597
+ * @description Lists the opening hours of this place or POI along with the popular or busy hours.
598
+ *
599
+ * A string is also provided that can be used for display.
600
+ */
601
+ Hours: {
602
+ /**
603
+ * @description The opening hours for a place.
604
+ *
605
+ * Opening hours are shown by day of the week. Each day can have
606
+ * several pairs of from and to times. For example, if a coffee shop is
607
+ * open from 9:00 until 12:00 and then again from 13:00 until 17:00, it
608
+ * would contain two pairs of from/to times: 09:00 paired with 12:00
609
+ * and 13:00 with 17:00. Opening hours are shown in 24-hour time in the
610
+ * local timezone of the place or POI.
611
+ *
612
+ * @example {
613
+ * "monday": [
614
+ * {
615
+ * "from": "09:00",
616
+ * "to": "17:00"
617
+ * }
618
+ * ],
619
+ * "tuesday": [
620
+ * {
621
+ * "from": "09:00",
622
+ * "to": "17:00"
623
+ * }
624
+ * ],
625
+ * "wednesday": [
626
+ * {
627
+ * "from": "09:00",
628
+ * "to": "12:00"
629
+ * },
630
+ * {
631
+ * "from": "13:00",
632
+ * "to": "17:00"
633
+ * }
634
+ * ],
635
+ * "thursday": [
636
+ * {
637
+ * "from": "09:00",
638
+ * "to": "17:00"
639
+ * }
640
+ * ],
641
+ * "friday": [
642
+ * {
643
+ * "from": "09:00",
644
+ * "to": "17:30"
645
+ * }
646
+ * ],
647
+ * "saturday": [
648
+ * {
649
+ * "from": "10:00",
650
+ * "to": "17:00"
651
+ * }
652
+ * ],
653
+ * "sunday": [
654
+ * {
655
+ * "from": "11:00",
656
+ * "to": "12:00"
657
+ * }
658
+ * ]
659
+ * }
660
+ */
661
+ opening?: components["schemas"]["HoursByDay"];
662
+ /**
663
+ * @description The popular or busy hours for a place.
664
+ *
665
+ * Popular hours are shown by day of the week. Each day can have
666
+ * several pairs of from and to times. For example, if a coffee shop is
667
+ * popular from 9:00 until 10:00 and then again from 14:00 until 15:00,
668
+ * it would contain two pairs of from/to times: 09:00 paired with 10:00
669
+ * and 14:00 with 15:00. Popular hours are shown in 24-hour time in the
670
+ * local timezone of the place or POI.
671
+ *
672
+ * @example {
673
+ * "monday": [
674
+ * {
675
+ * "from": "10:00",
676
+ * "to": "12:00"
677
+ * },
678
+ * {
679
+ * "from": "14:00",
680
+ * "to": "15:00"
681
+ * }
682
+ * ],
683
+ * "tuesday": [
684
+ * {
685
+ * "from": "14:00",
686
+ * "to": "15:00"
687
+ * }
688
+ * ],
689
+ * "wednesday": [
690
+ * {
691
+ * "from": "10:00",
692
+ * "to": "12:00"
693
+ * },
694
+ * {
695
+ * "from": "14:00",
696
+ * "to": "15:00"
697
+ * }
698
+ * ],
699
+ * "thursday": [
700
+ * {
701
+ * "from": "14:00",
702
+ * "to": "15:00"
703
+ * }
704
+ * ],
705
+ * "friday": [
706
+ * {
707
+ * "from": "15:00",
708
+ * "to": "17:00"
709
+ * }
710
+ * ],
711
+ * "saturday": [
712
+ * {
713
+ * "from": "10:00",
714
+ * "to": "12:00"
715
+ * }
716
+ * ],
717
+ * "sunday": [
718
+ * {
719
+ * "from": "11:00",
720
+ * "to": "12:00"
721
+ * }
722
+ * ]
723
+ * }
724
+ */
725
+ popular?: components["schemas"]["HoursByDay"];
726
+ /**
727
+ * @description The opening hours for this place, formatted for display.
728
+ *
729
+ * @example Mon-Thu 12:00 PM-11:00 PM; Fri-Sat 12:00 PM-11:30 PM; Sun 12:00 PM-10:30 PM
730
+ */
731
+ openingText?: string | null;
732
+ };
733
+ /** @description Rating information about the price and user rating of the place. */
734
+ Rating: {
735
+ /**
736
+ * @description An indication of the overall price of a place based on user reviews.
737
+ *
738
+ * @example cheap
739
+ * @enum {string|null}
740
+ */
741
+ price?: ("cheap" | "moderate" | "expensive" | "veryExpensive") | null;
742
+ /**
743
+ * Format: float
744
+ * @description A rating for the place based on user-reviews from 0 to 5, where 5 is the best rating.
745
+ *
746
+ * @example 4.5
747
+ */
748
+ user?: number | null;
749
+ };
750
+ /** @description The address of a place, or point of interest (POI). */
751
+ Address: {
752
+ /**
753
+ * @description The street address for a place, for example the street name and number.
754
+ *
755
+ * @example 380 New York St
756
+ */
757
+ streetAddress?: string | null;
758
+ /**
759
+ * @description Additional address information, including suite or apartment numbers.
760
+ *
761
+ * @example Unit 32
762
+ */
763
+ extended?: string | null;
764
+ /**
765
+ * @description The city, town, or equivalent.
766
+ * @example Redlands
767
+ */
768
+ locality?: string | null;
769
+ /**
770
+ * @description As defined by Nielsen, signifies a region where the population can receive similar TV and radio offerings (US only).
771
+ *
772
+ * @example Los Angeles
773
+ */
774
+ designatedMarketArea?: string | null;
775
+ /**
776
+ * @description The state, province, territory or equivalent.
777
+ *
778
+ * @example CA
779
+ */
780
+ region?: string | null;
781
+ /**
782
+ * @description Postal code or equivalent (zip code in the US).
783
+ *
784
+ * Format will be localized based on country.
785
+ *
786
+ * @example 92373
787
+ */
788
+ postcode?: string | null;
789
+ /** @description Post-office box. */
790
+ poBox?: string | null;
791
+ /**
792
+ * @description Two letter ISO country code
793
+ * @example US
794
+ */
795
+ country?: string | null;
796
+ /**
797
+ * @description Additional sub-division.
798
+ *
799
+ * Usually, but not always, a country sub-division (e.g., Scotland).
800
+ *
801
+ * @example Scotland
802
+ */
803
+ adminRegion?: string | null;
804
+ /**
805
+ * @description Town/place employed in postal addressing.
806
+ *
807
+ * @example Edinburgh
808
+ */
809
+ postTown?: string | null;
810
+ /**
811
+ * @description The neighborhoods of the place.
812
+ *
813
+ * @example [
814
+ * "Downtown"
815
+ * ]
816
+ */
817
+ neighborhood?: string[];
818
+ /**
819
+ * @description The census block Id of the place (US only).
820
+ *
821
+ * @example 60710081003002
822
+ */
823
+ censusBlockId?: string | null;
824
+ };
825
+ /** @description The social media details for a place. */
826
+ SocialMedia: {
827
+ /**
828
+ * @description The facebook Id of the place.
829
+ * @example 211211155280
830
+ */
831
+ facebookId?: string | null;
832
+ /**
833
+ * @description The twitter handle of the place.
834
+ * @example esri
835
+ */
836
+ twitter?: string | null;
837
+ /** @description The instagram ID of the place. */
838
+ instagram?: string | null;
839
+ };
840
+ /** @description The contact information for a place. */
841
+ ContactInfo: {
842
+ /**
843
+ * @description The telephone number of the place.
844
+ * @example (909) 793-2853
845
+ */
846
+ telephone?: string | null;
847
+ /**
848
+ * Format: url
849
+ * @description The website address of the place.
850
+ * @example https://www.esri.com/en-us/home
851
+ */
852
+ website?: string | null;
853
+ /**
854
+ * @description Fax number.
855
+ * @example 0800 169 2008
856
+ */
857
+ fax?: string | null;
858
+ /**
859
+ * @description Email address.
860
+ * @example support@esri.com
861
+ */
862
+ email?: string | null;
863
+ };
864
+ /** @description Information about a chain that a place belongs to. */
865
+ ChainInfo: {
866
+ /**
867
+ * @description The name of the chain.
868
+ *
869
+ * @example Starbucks
870
+ */
871
+ name?: string | null;
872
+ };
873
+ /** @description Provides links for accessing more results for the current request. */
874
+ Links: {
875
+ /**
876
+ * Format: url
877
+ * @description The base url for making a query to fetch more results.
878
+ *
879
+ * Combine this with the `previous` or `next` parameters to make a full
880
+ * request url.
881
+ *
882
+ * @example https://places-api.arcgis.com/
883
+ */
884
+ base?: string;
885
+ /**
886
+ * @description A url fragment that can be appended to the `base` property to make a request url to fetch the previous page of results.
887
+ *
888
+ * If this property is omitted there are no previous pages of results.
889
+ * You must also supply authentication details, such as a `token`, to
890
+ * make a previous request.
891
+ *
892
+ * @example /arcgis/rest/services/places-service/v1/places/near-point?x=-117.194769&y=34.057289&radius=50.0&offset=0&pageSize=10
893
+ */
894
+ previous?: string;
895
+ /**
896
+ * @description A url fragment that can be appended to the `base` property to make a request url to fetch the next page of results.
897
+ *
898
+ * If this property is omitted there are no more pages of results. You
899
+ * must also supply authentication details, such as a `token`, to make
900
+ * a next request.
901
+ *
902
+ * @example /arcgis/rest/services/places-service/v1/places/near-point?x=-117.194769&y=34.057289&radius=50.0&offset=20&pageSize=10
903
+ */
904
+ next?: string;
905
+ };
906
+ Error: {
907
+ /** @description Error information */
908
+ error: {
909
+ /**
910
+ * @description A code identifying the type of error.
911
+ *
912
+ * This can be an HTTP status code, `498` (invalid or expired
913
+ * token), or `499` (missing token).
914
+ *
915
+ * @example 400
916
+ * @enum {integer}
917
+ */
918
+ code: 400 | 401 | 403 | 404 | 498 | 499 | 500;
919
+ /**
920
+ * @description A message describing the error.
921
+ * @example Parameter invalid.
922
+ */
923
+ message: string;
924
+ /** @description List of details about the error. */
925
+ details?: string[];
926
+ /**
927
+ * Format: url
928
+ * @description A link to general information about the service, such as the owning system and token service URL.
929
+ *
930
+ * This property is only
931
+ * present for errors relating to tokens.
932
+ *
933
+ * @example https://places-api.arcgis.com/arcgis/rest/info
934
+ */
935
+ restInfoUrl?: string;
936
+ };
937
+ };
938
+ };
939
+ responses: {
940
+ /** Authentication Error. The API key or token is missing, invalid or expired. */
941
+ UnauthorizedErrorResponse: {
942
+ content: {
943
+ "application/json": components["schemas"]["Error"];
944
+ };
945
+ };
946
+ /** An error occurred on the server. */
947
+ ServerErrorResponse: {
948
+ content: {
949
+ "application/json": components["schemas"]["Error"];
950
+ };
951
+ };
952
+ /** Invalid query parameters. */
953
+ InvalidQueryErrorResponse: {
954
+ content: {
955
+ "application/json": components["schemas"]["Error"];
956
+ };
957
+ };
958
+ /** A resource with the supplied Id was not found. */
959
+ IdNotFoundErrorResponse: {
960
+ content: {
961
+ "application/json": components["schemas"]["Error"];
962
+ };
963
+ };
964
+ /** The required parameter 'token' is valid but does not have permission to access the service. */
965
+ PermissionMissingErrorResponse: {
966
+ content: {
967
+ "application/json": components["schemas"]["Error"];
968
+ };
969
+ };
970
+ /** A successful request to return details for a single category. */
971
+ CategoryDetailsResponse: {
972
+ content: {
973
+ "application/json": components["schemas"]["CategoryDetails"];
974
+ };
975
+ };
976
+ /** Details of categories that a `Place` can belong to. */
977
+ CategoriesDetailsResponse: {
978
+ content: {
979
+ "application/json": {
980
+ categories: components["schemas"]["CategoryDetails"][];
981
+ };
982
+ };
983
+ };
984
+ /** A successful response for a `places/near-point` request. */
985
+ NearPointResponse: {
986
+ content: {
987
+ "application/json": {
988
+ results: components["schemas"]["NearPointResult"][];
989
+ maxResultsExceeded?: components["schemas"]["MaxResultsExceeded"];
990
+ links?: components["schemas"]["Links"];
991
+ };
992
+ };
993
+ };
994
+ /** A successful response for a `places/within-extent` request. */
995
+ WithinExtentResponse: {
996
+ content: {
997
+ "application/json": {
998
+ results: components["schemas"]["WithinExtentResult"][];
999
+ maxResultsExceeded?: components["schemas"]["MaxResultsExceeded"];
1000
+ links?: components["schemas"]["Links"];
1001
+ };
1002
+ };
1003
+ };
1004
+ /** A successful response for a `places/{placeId}` request. */
1005
+ PlaceDetailsResponse: {
1006
+ content: {
1007
+ "application/json": {
1008
+ placeDetails: components["schemas"]["PlaceDetails"];
1009
+ };
1010
+ };
1011
+ };
1012
+ };
1013
+ parameters: {
1014
+ /**
1015
+ * @description The radius in meters to search for places - measured from the supplied `x` and `y` coordinate.
1016
+ *
1017
+ * A radius of 100 meters will result in a circular search area that is 200
1018
+ * meters in diameter. If omitted, the default search radius will be 1,000
1019
+ * meters.
1020
+ */
1021
+ RadiusParam: components["schemas"]["SearchDistance"];
1022
+ /**
1023
+ * @description The minimum x coordinate, or longitude, of the search extent.
1024
+ *
1025
+ * This is the furthest _west_ that will be searched.
1026
+ */
1027
+ XMinParam: components["schemas"]["XCoord"];
1028
+ /**
1029
+ * @description The minimum y coordinate, or latitude, of the search extent.
1030
+ *
1031
+ * This is the furthest _south_ that will be searched.
1032
+ */
1033
+ YMinParam: components["schemas"]["YCoord"];
1034
+ /**
1035
+ * @description The maximum x coordinate, or longitude, of the search extent.
1036
+ *
1037
+ * This is the furthest _east_ that will be searched.
1038
+ */
1039
+ XMaxParam: components["schemas"]["XCoord"];
1040
+ /**
1041
+ * @description The maximum y coordinate, or latitude, of the search extent.
1042
+ *
1043
+ * This is the furthest _north_ that will be searched.
1044
+ */
1045
+ YMaxParam: components["schemas"]["YCoord"];
1046
+ /**
1047
+ * @description Filters places to those that match the category Ids.
1048
+ *
1049
+ * Places will be returned if they match _any_ of the category Ids. If this
1050
+ * property is not set, places will be returned regardless of their
1051
+ * category.
1052
+ *
1053
+ * You can obtain information on category Ids from the
1054
+ * `places/categories` endpoint. For example, to filter for places
1055
+ * where the category is "Bicycle Store", include the categoryId
1056
+ * `17117` in this property.
1057
+ */
1058
+ CategoryIdsParam: components["schemas"]["CategoryId"][];
1059
+ /** @description Free search text for places against names, categories etc. */
1060
+ SearchTextParam: string;
1061
+ /**
1062
+ * @description The number of places that should be sent in the response for a single request.
1063
+ *
1064
+ * You can set this to any value up to `20` when you need to control the
1065
+ * size of responses that your app downloads.
1066
+ *
1067
+ * If the query results in more than this page size, then the response object
1068
+ * will contain a `next` url fragment. This fragment can be used to form a
1069
+ * request url to fetch the next page of results.
1070
+ *
1071
+ * The maximum number of places that can be returned in total is `200`. If
1072
+ * a request reaches this limit without returning all of the available
1073
+ * places, the response will contain the property
1074
+ * `"maxResultsExceeded":true` in addition to place results.
1075
+ */
1076
+ PageSizeParam: number;
1077
+ /**
1078
+ * @description Request results starting from the given offset.
1079
+ *
1080
+ * This parameter works with the `pageSize` parameter to fetch results from
1081
+ * subsequent pages. For example, with a page size of 2, setting the
1082
+ * `offset` to `2` would return the 3rd and 4th results.
1083
+ *
1084
+ * Regardless of paging, the maximum number of places that can be returned
1085
+ * by a single query is `200`. When a query results in more than `200`
1086
+ * places, the response will contain the property
1087
+ * `"maxResultsExceeded":true` in addition to place results.
1088
+ */
1089
+ OffsetParam: number;
1090
+ /**
1091
+ * @description The requested response format - either `json` or `pjson` (pretty json).
1092
+ *
1093
+ * @example pjson
1094
+ */
1095
+ FormatParam: "json" | "pjson";
1096
+ /** @description The ID of the category that you want to fetch details for. */
1097
+ CategoryIdParam: components["schemas"]["CategoryId"];
1098
+ /**
1099
+ * @description A text filter that will be used for searching categories.
1100
+ *
1101
+ * The text must be at least three characters and will be applied as a
1102
+ * partial match. For example, using the filter "off" would return
1103
+ * categories using the word "Office" as well as those using the word
1104
+ * "Coffee".
1105
+ */
1106
+ CategoriesFilterParam: string;
1107
+ /**
1108
+ * @description The array of fields that define the attributes to return for a place.
1109
+ *
1110
+ * Use this parameter to define the attributes you would like returned,
1111
+ * for example `["name", "address:streetAddress"]`. However, you can also
1112
+ * set this value to `["all"]` to return all of the attributes available
1113
+ * for a place.
1114
+ *
1115
+ * The `placeId` attribute is always returned in addition to the other
1116
+ * attributes you requested. If a valid attribute value is not available,
1117
+ * `null`, or an empty collection, is returned and you are not charged for it. To see the fields and
1118
+ * pricing groups they belong to, go to the table above.
1119
+ */
1120
+ RequestedFieldsParam: ("all" | "address" | "address:adminRegion" | "address:censusBlockId" | "address:country" | "address:designatedMarketArea" | "address:extended" | "address:locality" | "address:neighborhood" | "address:poBox" | "address:postcode" | "address:postTown" | "address:region" | "address:streetAddress" | "categories" | "contactInfo" | "contactInfo:email" | "contactInfo:fax" | "contactInfo:telephone" | "contactInfo:website" | "chains" | "description" | "hours" | "hours:opening" | "hours:openingText" | "hours:popular" | "name" | "rating" | "rating:price" | "rating:user" | "socialMedia" | "socialMedia:facebookId" | "socialMedia:instagram" | "socialMedia:twitter")[];
1121
+ };
1122
+ }
1123
+ export interface operations {
1124
+ /**
1125
+ * A category describes a type of place, such as "movie theater" or "zoo".
1126
+ * The places service has over 1,000 categories (or types) of place. The
1127
+ * categories fall into ten general groups: Arts and Entertainment, Business
1128
+ * and Professional Services, Community and Government, Dining and Drinking,
1129
+ * Events, Health and Medicine, Landmarks and Outdoors, Retail, Sports and
1130
+ * Recreation, and Travel and Transportation.
1131
+ *
1132
+ * There are up to four levels of categories. For example: "Travel and
1133
+ * Transportation" (Level 1), "Transport Hub" (Level 2), "Airport"
1134
+ * (Level 3) and "Airport Terminal" (Level 4).
1135
+ *
1136
+ * The table below shows the top-level of categories, along with a
1137
+ * selection of level two categories.
1138
+ *
1139
+ * The `/categories` endpoint fetches the latest set of place categories.
1140
+ * The request returns all categories including their label and
1141
+ * `categoryId`. You should use this endpoint to fetch the latest set of
1142
+ * categories when your app starts up. Each category contains an unique ID
1143
+ * that you can use to perform a `near-point` or `within-extent` search.
1144
+ *
1145
+ * You can also reduce the list to a subset of categories using the
1146
+ * `filter` parameter. For example, searching for "coffee" would return
1147
+ * categories including:
1148
+ *
1149
+ * - "Coffee Shop"
1150
+ *
1151
+ * - "Coffee Roaster"
1152
+ *
1153
+ * - "Turkish Coffeehouse"
1154
+ *
1155
+ * |Category Label | Category ID | Level 2|
1156
+ * |--- | --- | ---|
1157
+ * |Arts and Entertainment | 10000 | Amusement Park (10001), Art Gallery (10004), Casino (10008), Exhibit (10016), Movie Theater (10024), Museum (10027), Stadium (10051), Water Park (10055), Zoo (10056), ...|
1158
+ * |Business and Professional Services | 11000 | Construction (11028), Convention Center (11029), Food and Beverage Service (11056), Health and Beauty Service (11061), Industrial Estate (11106), Office (11124), ...|
1159
+ * |Community and Government | 12000 | Education (12009), Organization (12082), Government Building (12064), Community Center (12004), Library (12080), Utility Company (12115), ...|
1160
+ * |Dining and Drinking | 13000 | Bakery (13002), Bar (13003), Cafes, Coffee, and Tea House (13032), Restaurant (13065, ...|
1161
+ * |Event | 14000 | Conference (14001), Convention (14002), Entertainment Event (14003), Marketplace (14009), ...|
1162
+ * |Health and Medicine | 15000 | Dentist (15007), Emergency Service (15008), Hospital (15014), Medical Center (15016), Optometrist (15024), Physician (15027), Veterinarian (15054), ...|
1163
+ * |Landmarks and Outdoors | 16000 | Beach (16003), Building / Structure (16007), Campground (16008), Harbor / Marina (16018), Historic and Protected Site (16020), Monument (16026), Nature Preserve (16028), Park (16032), ...|
1164
+ * |Retail | 17000 | Arts and Crafts Store (17003), Bookstore (17018), Convenience Store (17029), Department Store (17033)|
1165
+ * |Sports and Recreation | 18000 | Athletic Field (18001), Baseball (18002), Basketball (18006), Football (18013), Golf (18016), Gym and Studio (18021), ...|
1166
+ * |Travel and Transportation | 19000 | Bike Rental (19002), Cruise (19005), Electric Vehicle Charging Station (19006), Fuel Station (19007), Lodging (19009), Transport Hub (19030), ...|
1167
+ *
1168
+ * **Note**: Category details are subject to change as new types of places
1169
+ * are introduced.
1170
+ */
1171
+ categoriesGet: {
1172
+ parameters: {
1173
+ query: {
1174
+ /**
1175
+ * A text filter that will be used for searching categories.
1176
+ *
1177
+ * The text must be at least three characters and will be applied as a
1178
+ * partial match. For example, using the filter "off" would return
1179
+ * categories using the word "Office" as well as those using the word
1180
+ * "Coffee".
1181
+ */
1182
+ filter?: components["parameters"]["CategoriesFilterParam"];
1183
+ /** The requested response format - either `json` or `pjson` (pretty json). */
1184
+ f?: components["parameters"]["FormatParam"];
1185
+ };
1186
+ };
1187
+ responses: {
1188
+ 200: components["responses"]["CategoriesDetailsResponse"];
1189
+ 400: components["responses"]["InvalidQueryErrorResponse"];
1190
+ 401: components["responses"]["UnauthorizedErrorResponse"];
1191
+ 403: components["responses"]["PermissionMissingErrorResponse"];
1192
+ "5XX": components["responses"]["ServerErrorResponse"];
1193
+ };
1194
+ };
1195
+ /** The `/categories/{categoryId}` operation returns all the groups to which the category belongs. You must supply a `category ID` to use this operation. */
1196
+ categoriesCategoryIdGet: {
1197
+ parameters: {
1198
+ path: {
1199
+ /** The ID of the category that you want to fetch details for. */
1200
+ categoryId: components["parameters"]["CategoryIdParam"];
1201
+ };
1202
+ query: {
1203
+ /** The requested response format - either `json` or `pjson` (pretty json). */
1204
+ f?: components["parameters"]["FormatParam"];
1205
+ };
1206
+ };
1207
+ responses: {
1208
+ 200: components["responses"]["CategoryDetailsResponse"];
1209
+ 400: components["responses"]["InvalidQueryErrorResponse"];
1210
+ 401: components["responses"]["UnauthorizedErrorResponse"];
1211
+ 403: components["responses"]["PermissionMissingErrorResponse"];
1212
+ 404: components["responses"]["IdNotFoundErrorResponse"];
1213
+ "5XX": components["responses"]["ServerErrorResponse"];
1214
+ };
1215
+ };
1216
+ /**
1217
+ * The `/places/near-point` operation finds places that are within a given
1218
+ * radius of a specified location. The returned places contain basic data
1219
+ * such as name, category and location.
1220
+ *
1221
+ * To perform the request, you must supply the `x` and `y` coordinates of
1222
+ * the point from which to search. Optionally, you can also specify the:
1223
+ *
1224
+ * - Search radius (up to 10,000 meters)
1225
+ * - Category IDs
1226
+ * - Search text
1227
+ *
1228
+ * If the `maxResultsExceeded` property in the response is `true`, then you
1229
+ * can page through the results to return more places. The maximum number
1230
+ * of places that cane be paged to is 200.
1231
+ *
1232
+ * **Note**: You cannot permanently store places. Please see the [Terms of
1233
+ * use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
1234
+ */
1235
+ nearPointGet: {
1236
+ parameters: {
1237
+ query: {
1238
+ /** The x coordinate, or longitude, to search from, in WGS84 decimal degrees. */
1239
+ x: components["schemas"]["XCoord"];
1240
+ /** The y coordinate, or latitude, to search from, in WGS84 decimal degrees. */
1241
+ y: components["schemas"]["YCoord"];
1242
+ /**
1243
+ * The radius in meters to search for places - measured from the supplied `x` and `y` coordinate.
1244
+ *
1245
+ * A radius of 100 meters will result in a circular search area that is 200
1246
+ * meters in diameter. If omitted, the default search radius will be 1,000
1247
+ * meters.
1248
+ */
1249
+ radius?: components["parameters"]["RadiusParam"];
1250
+ /**
1251
+ * Filters places to those that match the category Ids.
1252
+ *
1253
+ * Places will be returned if they match _any_ of the category Ids. If this
1254
+ * property is not set, places will be returned regardless of their
1255
+ * category.
1256
+ *
1257
+ * You can obtain information on category Ids from the
1258
+ * `places/categories` endpoint. For example, to filter for places
1259
+ * where the category is "Bicycle Store", include the categoryId
1260
+ * `17117` in this property.
1261
+ */
1262
+ categoryIds?: components["parameters"]["CategoryIdsParam"];
1263
+ /** Free search text for places against names, categories etc. */
1264
+ searchText?: components["parameters"]["SearchTextParam"];
1265
+ /**
1266
+ * The number of places that should be sent in the response for a single request.
1267
+ *
1268
+ * You can set this to any value up to `20` when you need to control the
1269
+ * size of responses that your app downloads.
1270
+ *
1271
+ * If the query results in more than this page size, then the response object
1272
+ * will contain a `next` url fragment. This fragment can be used to form a
1273
+ * request url to fetch the next page of results.
1274
+ *
1275
+ * The maximum number of places that can be returned in total is `200`. If
1276
+ * a request reaches this limit without returning all of the available
1277
+ * places, the response will contain the property
1278
+ * `"maxResultsExceeded":true` in addition to place results.
1279
+ */
1280
+ pageSize?: components["parameters"]["PageSizeParam"];
1281
+ /**
1282
+ * Request results starting from the given offset.
1283
+ *
1284
+ * This parameter works with the `pageSize` parameter to fetch results from
1285
+ * subsequent pages. For example, with a page size of 2, setting the
1286
+ * `offset` to `2` would return the 3rd and 4th results.
1287
+ *
1288
+ * Regardless of paging, the maximum number of places that can be returned
1289
+ * by a single query is `200`. When a query results in more than `200`
1290
+ * places, the response will contain the property
1291
+ * `"maxResultsExceeded":true` in addition to place results.
1292
+ */
1293
+ offset?: components["parameters"]["OffsetParam"];
1294
+ /** The requested response format - either `json` or `pjson` (pretty json). */
1295
+ f?: components["parameters"]["FormatParam"];
1296
+ };
1297
+ };
1298
+ responses: {
1299
+ 200: components["responses"]["NearPointResponse"];
1300
+ 400: components["responses"]["InvalidQueryErrorResponse"];
1301
+ 401: components["responses"]["UnauthorizedErrorResponse"];
1302
+ 403: components["responses"]["PermissionMissingErrorResponse"];
1303
+ "5XX": components["responses"]["ServerErrorResponse"];
1304
+ };
1305
+ };
1306
+ /**
1307
+ * The `/places/within-extent` operation searches for places within an extent (bounding box).
1308
+ *
1309
+ * You must supply the `xmin`,
1310
+ * `ymin`, `xmax` and `ymax` coordinates to define the extent. The maximum width
1311
+ * and height of an extent that can be used in a search is 20,000 meters.
1312
+ *
1313
+ * You can also provide multiple categories or search text to find specific types of places within the extent.
1314
+ *
1315
+ * The default number of places returned (`pageSize`) is 10. The maximum `pageSize` value is 20.
1316
+ *
1317
+ * If the `maxResultsExceeded` property in the response is `true`, then you
1318
+ * can page through the results to return more places. The maximum number
1319
+ * of places that cane be paged to is 200.
1320
+ *
1321
+ * **Note**: You cannot permanently store places. Please see the [Terms of
1322
+ * use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
1323
+ */
1324
+ withinExtentGet: {
1325
+ parameters: {
1326
+ query: {
1327
+ /**
1328
+ * The minimum x coordinate, or longitude, of the search extent.
1329
+ *
1330
+ * This is the furthest _west_ that will be searched.
1331
+ */
1332
+ xmin: components["parameters"]["XMinParam"];
1333
+ /**
1334
+ * The minimum y coordinate, or latitude, of the search extent.
1335
+ *
1336
+ * This is the furthest _south_ that will be searched.
1337
+ */
1338
+ ymin: components["parameters"]["YMinParam"];
1339
+ /**
1340
+ * The maximum x coordinate, or longitude, of the search extent.
1341
+ *
1342
+ * This is the furthest _east_ that will be searched.
1343
+ */
1344
+ xmax: components["parameters"]["XMaxParam"];
1345
+ /**
1346
+ * The maximum y coordinate, or latitude, of the search extent.
1347
+ *
1348
+ * This is the furthest _north_ that will be searched.
1349
+ */
1350
+ ymax: components["parameters"]["YMaxParam"];
1351
+ /**
1352
+ * Filters places to those that match the category Ids.
1353
+ *
1354
+ * Places will be returned if they match _any_ of the category Ids. If this
1355
+ * property is not set, places will be returned regardless of their
1356
+ * category.
1357
+ *
1358
+ * You can obtain information on category Ids from the
1359
+ * `places/categories` endpoint. For example, to filter for places
1360
+ * where the category is "Bicycle Store", include the categoryId
1361
+ * `17117` in this property.
1362
+ */
1363
+ categoryIds?: components["parameters"]["CategoryIdsParam"];
1364
+ /** Free search text for places against names, categories etc. */
1365
+ searchText?: components["parameters"]["SearchTextParam"];
1366
+ /**
1367
+ * The number of places that should be sent in the response for a single request.
1368
+ *
1369
+ * You can set this to any value up to `20` when you need to control the
1370
+ * size of responses that your app downloads.
1371
+ *
1372
+ * If the query results in more than this page size, then the response object
1373
+ * will contain a `next` url fragment. This fragment can be used to form a
1374
+ * request url to fetch the next page of results.
1375
+ *
1376
+ * The maximum number of places that can be returned in total is `200`. If
1377
+ * a request reaches this limit without returning all of the available
1378
+ * places, the response will contain the property
1379
+ * `"maxResultsExceeded":true` in addition to place results.
1380
+ */
1381
+ pageSize?: components["parameters"]["PageSizeParam"];
1382
+ /**
1383
+ * Request results starting from the given offset.
1384
+ *
1385
+ * This parameter works with the `pageSize` parameter to fetch results from
1386
+ * subsequent pages. For example, with a page size of 2, setting the
1387
+ * `offset` to `2` would return the 3rd and 4th results.
1388
+ *
1389
+ * Regardless of paging, the maximum number of places that can be returned
1390
+ * by a single query is `200`. When a query results in more than `200`
1391
+ * places, the response will contain the property
1392
+ * `"maxResultsExceeded":true` in addition to place results.
1393
+ */
1394
+ offset?: components["parameters"]["OffsetParam"];
1395
+ /** The requested response format - either `json` or `pjson` (pretty json). */
1396
+ f?: components["parameters"]["FormatParam"];
1397
+ };
1398
+ };
1399
+ responses: {
1400
+ 200: components["responses"]["WithinExtentResponse"];
1401
+ 400: components["responses"]["InvalidQueryErrorResponse"];
1402
+ 401: components["responses"]["UnauthorizedErrorResponse"];
1403
+ 403: components["responses"]["PermissionMissingErrorResponse"];
1404
+ "5XX": components["responses"]["ServerErrorResponse"];
1405
+ };
1406
+ };
1407
+ /**
1408
+ * The `/places/{placeId}` operation returns details for a place.
1409
+ *
1410
+ * To request details, you use the `requestedFields` parameter to specify
1411
+ * the fields and the attributes you want from the **Place**,
1412
+ * **Address**, and/or **Details** price groups.
1413
+ *
1414
+ * It is always recommended to specify the fields you want, however, you
1415
+ * can also use `requestedFields=all` to return all of the attributes
1416
+ * available. By default, The `placeId` attribute is always returned in addition
1417
+ * to the other attributes you requested.
1418
+ *
1419
+ * The attributes available for places may vary. For example, opening hours
1420
+ * may not be available (or applicable) for geographic places or landmarks.
1421
+ *
1422
+ * You will only be charged for attributes that contain valid values for
1423
+ * the requested fields. If no data is available for the requested field,
1424
+ * `null` or an empty collection is returned and you are not charged. You are only charged once if
1425
+ * one or more attributes with valid values are returned from a price
1426
+ * group. To learn more, go to
1427
+ * [Pricing](https://places-service-preview.sites.afd.arcgis.com/rest/places/#pricing).
1428
+ *
1429
+ * Field | Price group
1430
+ * --- | ---
1431
+ * name | Place
1432
+ * categoryId | Place
1433
+ * address:country | Address
1434
+ * address:adminRegion | Address
1435
+ * address:region | Address
1436
+ * address:streetAddress | Address
1437
+ * address:extended | Address
1438
+ * address:poBox | Address
1439
+ * address:postcode | Address
1440
+ * address:postTown | Address
1441
+ * address:locality | Address
1442
+ * address:neighborhood | Address
1443
+ * address:censusBlockId | Address
1444
+ * address:designatedMarketArea | Address
1445
+ * contactInfo:telephone | Details
1446
+ * contactInfo:website | Details
1447
+ * contactInfo:fax | Details
1448
+ * contactInfo:email | Details
1449
+ * socialMedia:facebookId | Details
1450
+ * socialMedia:instagram | Details
1451
+ * socialMedia:twitter | Details
1452
+ * chains | Details
1453
+ * description | Details
1454
+ * rating:user | Details
1455
+ * rating:price | Details
1456
+ * hours:opening | Details
1457
+ * hours:popular | Details
1458
+ * hours:openingText | Details
1459
+ *
1460
+ * **Note**: You cannot permanently store places. Please see the [Terms of
1461
+ * use](https://developers.arcgis.com/documentation/mapping-apis-and-services/deployment/terms-of-use/).
1462
+ */
1463
+ placeIdGet: {
1464
+ parameters: {
1465
+ path: {
1466
+ /** The Id of the place for which you want to fetch additional details. */
1467
+ placeId: components["schemas"]["PlaceId"];
1468
+ };
1469
+ query: {
1470
+ /**
1471
+ * The array of fields that define the attributes to return for a place.
1472
+ *
1473
+ * Use this parameter to define the attributes you would like returned,
1474
+ * for example `["name", "address:streetAddress"]`. However, you can also
1475
+ * set this value to `["all"]` to return all of the attributes available
1476
+ * for a place.
1477
+ *
1478
+ * The `placeId` attribute is always returned in addition to the other
1479
+ * attributes you requested. If a valid attribute value is not available,
1480
+ * `null`, or an empty collection, is returned and you are not charged for it. To see the fields and
1481
+ * pricing groups they belong to, go to the table above.
1482
+ */
1483
+ requestedFields: components["parameters"]["RequestedFieldsParam"];
1484
+ /** The requested response format - either `json` or `pjson` (pretty json). */
1485
+ f?: components["parameters"]["FormatParam"];
1486
+ };
1487
+ };
1488
+ responses: {
1489
+ 200: components["responses"]["PlaceDetailsResponse"];
1490
+ 400: components["responses"]["InvalidQueryErrorResponse"];
1491
+ 401: components["responses"]["UnauthorizedErrorResponse"];
1492
+ 403: components["responses"]["PermissionMissingErrorResponse"];
1493
+ 404: components["responses"]["IdNotFoundErrorResponse"];
1494
+ "5XX": components["responses"]["ServerErrorResponse"];
1495
+ };
1496
+ };
1497
+ }
1498
+ export interface external {
1499
+ }