Skip to content

Map Api

immichpy.client.generated.api.map_api.MapApi

MapApi(api_client=None)

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Source code in immichpy/client/generated/api/map_api.py
37
38
39
40
def __init__(self, api_client=None) -> None:
    if api_client is None:
        api_client = ApiClient.get_default()
    self.api_client = api_client

get_map_markers async

get_map_markers(file_created_after: Annotated[Optional[datetime], Field(description='Filter assets created after this date')] = None, file_created_before: Annotated[Optional[datetime], Field(description='Filter assets created before this date')] = None, is_archived: Annotated[Optional[StrictBool], Field(description='Filter by archived status')] = None, is_favorite: Annotated[Optional[StrictBool], Field(description='Filter by favorite status')] = None, with_partners: Annotated[Optional[StrictBool], Field(description='Include partner assets')] = None, with_shared_albums: Annotated[Optional[StrictBool], Field(description='Include shared album assets')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> List[MapMarkerResponseDto]

Retrieve map markers

Retrieve a list of latitude and longitude coordinates for every asset with location data.

Parameters:

Name Type Description Default
file_created_after Annotated[Optional[datetime], Field(description='Filter assets created after this date')]

Filter assets created after this date

None
file_created_before Annotated[Optional[datetime], Field(description='Filter assets created before this date')]

Filter assets created before this date

None
is_archived Annotated[Optional[StrictBool], Field(description='Filter by archived status')]

Filter by archived status

None
is_favorite Annotated[Optional[StrictBool], Field(description='Filter by favorite status')]

Filter by favorite status

None
with_partners Annotated[Optional[StrictBool], Field(description='Include partner assets')]

Include partner assets

None
with_shared_albums Annotated[Optional[StrictBool], Field(description='Include shared album assets')]

Include shared album assets

None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

None
_content_type Optional[StrictStr]

force content-type for the request.

None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

0

Returns:

Type Description
List[MapMarkerResponseDto]

Returns the result object.

Source code in immichpy/client/generated/api/map_api.py
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
@validate_call
async def get_map_markers(
    self,
    file_created_after: Annotated[
        Optional[datetime],
        Field(description="Filter assets created after this date"),
    ] = None,
    file_created_before: Annotated[
        Optional[datetime],
        Field(description="Filter assets created before this date"),
    ] = None,
    is_archived: Annotated[
        Optional[StrictBool], Field(description="Filter by archived status")
    ] = None,
    is_favorite: Annotated[
        Optional[StrictBool], Field(description="Filter by favorite status")
    ] = None,
    with_partners: Annotated[
        Optional[StrictBool], Field(description="Include partner assets")
    ] = None,
    with_shared_albums: Annotated[
        Optional[StrictBool], Field(description="Include shared album assets")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[MapMarkerResponseDto]:
    """Retrieve map markers

    Retrieve a list of latitude and longitude coordinates for every asset with location data.

    :param file_created_after: Filter assets created after this date
    :type file_created_after: datetime
    :param file_created_before: Filter assets created before this date
    :type file_created_before: datetime
    :param is_archived: Filter by archived status
    :type is_archived: bool
    :param is_favorite: Filter by favorite status
    :type is_favorite: bool
    :param with_partners: Include partner assets
    :type with_partners: bool
    :param with_shared_albums: Include shared album assets
    :type with_shared_albums: bool
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_map_markers_serialize(
        file_created_after=file_created_after,
        file_created_before=file_created_before,
        is_archived=is_archived,
        is_favorite=is_favorite,
        with_partners=with_partners,
        with_shared_albums=with_shared_albums,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[MapMarkerResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

get_map_markers_with_http_info async

get_map_markers_with_http_info(file_created_after: Annotated[Optional[datetime], Field(description='Filter assets created after this date')] = None, file_created_before: Annotated[Optional[datetime], Field(description='Filter assets created before this date')] = None, is_archived: Annotated[Optional[StrictBool], Field(description='Filter by archived status')] = None, is_favorite: Annotated[Optional[StrictBool], Field(description='Filter by favorite status')] = None, with_partners: Annotated[Optional[StrictBool], Field(description='Include partner assets')] = None, with_shared_albums: Annotated[Optional[StrictBool], Field(description='Include shared album assets')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[List[MapMarkerResponseDto]]

Retrieve map markers

Retrieve a list of latitude and longitude coordinates for every asset with location data.

Parameters:

Name Type Description Default
file_created_after Annotated[Optional[datetime], Field(description='Filter assets created after this date')]

Filter assets created after this date

None
file_created_before Annotated[Optional[datetime], Field(description='Filter assets created before this date')]

Filter assets created before this date

None
is_archived Annotated[Optional[StrictBool], Field(description='Filter by archived status')]

Filter by archived status

None
is_favorite Annotated[Optional[StrictBool], Field(description='Filter by favorite status')]

Filter by favorite status

None
with_partners Annotated[Optional[StrictBool], Field(description='Include partner assets')]

Include partner assets

None
with_shared_albums Annotated[Optional[StrictBool], Field(description='Include shared album assets')]

Include shared album assets

None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

None
_content_type Optional[StrictStr]

force content-type for the request.

None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

0

Returns:

Type Description
ApiResponse[List[MapMarkerResponseDto]]

Returns the result object.

Source code in immichpy/client/generated/api/map_api.py
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
@validate_call
async def get_map_markers_with_http_info(
    self,
    file_created_after: Annotated[
        Optional[datetime],
        Field(description="Filter assets created after this date"),
    ] = None,
    file_created_before: Annotated[
        Optional[datetime],
        Field(description="Filter assets created before this date"),
    ] = None,
    is_archived: Annotated[
        Optional[StrictBool], Field(description="Filter by archived status")
    ] = None,
    is_favorite: Annotated[
        Optional[StrictBool], Field(description="Filter by favorite status")
    ] = None,
    with_partners: Annotated[
        Optional[StrictBool], Field(description="Include partner assets")
    ] = None,
    with_shared_albums: Annotated[
        Optional[StrictBool], Field(description="Include shared album assets")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[MapMarkerResponseDto]]:
    """Retrieve map markers

    Retrieve a list of latitude and longitude coordinates for every asset with location data.

    :param file_created_after: Filter assets created after this date
    :type file_created_after: datetime
    :param file_created_before: Filter assets created before this date
    :type file_created_before: datetime
    :param is_archived: Filter by archived status
    :type is_archived: bool
    :param is_favorite: Filter by favorite status
    :type is_favorite: bool
    :param with_partners: Include partner assets
    :type with_partners: bool
    :param with_shared_albums: Include shared album assets
    :type with_shared_albums: bool
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_map_markers_serialize(
        file_created_after=file_created_after,
        file_created_before=file_created_before,
        is_archived=is_archived,
        is_favorite=is_favorite,
        with_partners=with_partners,
        with_shared_albums=with_shared_albums,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[MapMarkerResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

get_map_markers_without_preload_content async

get_map_markers_without_preload_content(file_created_after: Annotated[Optional[datetime], Field(description='Filter assets created after this date')] = None, file_created_before: Annotated[Optional[datetime], Field(description='Filter assets created before this date')] = None, is_archived: Annotated[Optional[StrictBool], Field(description='Filter by archived status')] = None, is_favorite: Annotated[Optional[StrictBool], Field(description='Filter by favorite status')] = None, with_partners: Annotated[Optional[StrictBool], Field(description='Include partner assets')] = None, with_shared_albums: Annotated[Optional[StrictBool], Field(description='Include shared album assets')] = None, _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Retrieve map markers

Retrieve a list of latitude and longitude coordinates for every asset with location data.

Parameters:

Name Type Description Default
file_created_after Annotated[Optional[datetime], Field(description='Filter assets created after this date')]

Filter assets created after this date

None
file_created_before Annotated[Optional[datetime], Field(description='Filter assets created before this date')]

Filter assets created before this date

None
is_archived Annotated[Optional[StrictBool], Field(description='Filter by archived status')]

Filter by archived status

None
is_favorite Annotated[Optional[StrictBool], Field(description='Filter by favorite status')]

Filter by favorite status

None
with_partners Annotated[Optional[StrictBool], Field(description='Include partner assets')]

Include partner assets

None
with_shared_albums Annotated[Optional[StrictBool], Field(description='Include shared album assets')]

Include shared album assets

None
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

None
_content_type Optional[StrictStr]

force content-type for the request.

None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

0

Returns:

Type Description
RESTResponseType

Returns the result object.

Source code in immichpy/client/generated/api/map_api.py
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
@validate_call
async def get_map_markers_without_preload_content(
    self,
    file_created_after: Annotated[
        Optional[datetime],
        Field(description="Filter assets created after this date"),
    ] = None,
    file_created_before: Annotated[
        Optional[datetime],
        Field(description="Filter assets created before this date"),
    ] = None,
    is_archived: Annotated[
        Optional[StrictBool], Field(description="Filter by archived status")
    ] = None,
    is_favorite: Annotated[
        Optional[StrictBool], Field(description="Filter by favorite status")
    ] = None,
    with_partners: Annotated[
        Optional[StrictBool], Field(description="Include partner assets")
    ] = None,
    with_shared_albums: Annotated[
        Optional[StrictBool], Field(description="Include shared album assets")
    ] = None,
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Retrieve map markers

    Retrieve a list of latitude and longitude coordinates for every asset with location data.

    :param file_created_after: Filter assets created after this date
    :type file_created_after: datetime
    :param file_created_before: Filter assets created before this date
    :type file_created_before: datetime
    :param is_archived: Filter by archived status
    :type is_archived: bool
    :param is_favorite: Filter by favorite status
    :type is_favorite: bool
    :param with_partners: Include partner assets
    :type with_partners: bool
    :param with_shared_albums: Include shared album assets
    :type with_shared_albums: bool
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._get_map_markers_serialize(
        file_created_after=file_created_after,
        file_created_before=file_created_before,
        is_archived=is_archived,
        is_favorite=is_favorite,
        with_partners=with_partners,
        with_shared_albums=with_shared_albums,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[MapMarkerResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response

reverse_geocode async

reverse_geocode(lat: Annotated[Union[StrictFloat, StrictInt], Field(description='Latitude (-90 to 90)')], lon: Annotated[Union[StrictFloat, StrictInt], Field(description='Longitude (-180 to 180)')], _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> List[MapReverseGeocodeResponseDto]

Reverse geocode coordinates

Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.

Parameters:

Name Type Description Default
lat Annotated[Union[StrictFloat, StrictInt], Field(description='Latitude (-90 to 90)')]

Latitude (-90 to 90) (required)

required
lon Annotated[Union[StrictFloat, StrictInt], Field(description='Longitude (-180 to 180)')]

Longitude (-180 to 180) (required)

required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

None
_content_type Optional[StrictStr]

force content-type for the request.

None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

0

Returns:

Type Description
List[MapReverseGeocodeResponseDto]

Returns the result object.

Source code in immichpy/client/generated/api/map_api.py
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
@validate_call
async def reverse_geocode(
    self,
    lat: Annotated[
        Union[StrictFloat, StrictInt], Field(description="Latitude (-90 to 90)")
    ],
    lon: Annotated[
        Union[StrictFloat, StrictInt], Field(description="Longitude (-180 to 180)")
    ],
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> List[MapReverseGeocodeResponseDto]:
    """Reverse geocode coordinates

    Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.

    :param lat: Latitude (-90 to 90) (required)
    :type lat: float
    :param lon: Longitude (-180 to 180) (required)
    :type lon: float
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._reverse_geocode_serialize(
        lat=lat,
        lon=lon,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[MapReverseGeocodeResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    ).data

reverse_geocode_with_http_info async

reverse_geocode_with_http_info(lat: Annotated[Union[StrictFloat, StrictInt], Field(description='Latitude (-90 to 90)')], lon: Annotated[Union[StrictFloat, StrictInt], Field(description='Longitude (-180 to 180)')], _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> ApiResponse[List[MapReverseGeocodeResponseDto]]

Reverse geocode coordinates

Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.

Parameters:

Name Type Description Default
lat Annotated[Union[StrictFloat, StrictInt], Field(description='Latitude (-90 to 90)')]

Latitude (-90 to 90) (required)

required
lon Annotated[Union[StrictFloat, StrictInt], Field(description='Longitude (-180 to 180)')]

Longitude (-180 to 180) (required)

required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

None
_content_type Optional[StrictStr]

force content-type for the request.

None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

0

Returns:

Type Description
ApiResponse[List[MapReverseGeocodeResponseDto]]

Returns the result object.

Source code in immichpy/client/generated/api/map_api.py
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
@validate_call
async def reverse_geocode_with_http_info(
    self,
    lat: Annotated[
        Union[StrictFloat, StrictInt], Field(description="Latitude (-90 to 90)")
    ],
    lon: Annotated[
        Union[StrictFloat, StrictInt], Field(description="Longitude (-180 to 180)")
    ],
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> ApiResponse[List[MapReverseGeocodeResponseDto]]:
    """Reverse geocode coordinates

    Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.

    :param lat: Latitude (-90 to 90) (required)
    :type lat: float
    :param lon: Longitude (-180 to 180) (required)
    :type lon: float
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._reverse_geocode_serialize(
        lat=lat,
        lon=lon,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[MapReverseGeocodeResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    await response_data.read()
    return self.api_client.response_deserialize(
        response_data=response_data,
        response_types_map=_response_types_map,
    )

reverse_geocode_without_preload_content async

reverse_geocode_without_preload_content(lat: Annotated[Union[StrictFloat, StrictInt], Field(description='Latitude (-90 to 90)')], lon: Annotated[Union[StrictFloat, StrictInt], Field(description='Longitude (-180 to 180)')], _request_timeout: Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]] = None, _request_auth: Optional[Dict[StrictStr, Any]] = None, _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0) -> RESTResponseType

Reverse geocode coordinates

Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.

Parameters:

Name Type Description Default
lat Annotated[Union[StrictFloat, StrictInt], Field(description='Latitude (-90 to 90)')]

Latitude (-90 to 90) (required)

required
lon Annotated[Union[StrictFloat, StrictInt], Field(description='Longitude (-180 to 180)')]

Longitude (-180 to 180) (required)

required
_request_timeout Union[None, Annotated[StrictFloat, Field(gt=0)], Tuple[Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]]]

timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

None
_request_auth Optional[Dict[StrictStr, Any]]

set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

None
_content_type Optional[StrictStr]

force content-type for the request.

None
_headers Optional[Dict[StrictStr, Any]]

set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

None
_host_index Annotated[StrictInt, Field(ge=0, le=0)]

set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

0

Returns:

Type Description
RESTResponseType

Returns the result object.

Source code in immichpy/client/generated/api/map_api.py
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
@validate_call
async def reverse_geocode_without_preload_content(
    self,
    lat: Annotated[
        Union[StrictFloat, StrictInt], Field(description="Latitude (-90 to 90)")
    ],
    lon: Annotated[
        Union[StrictFloat, StrictInt], Field(description="Longitude (-180 to 180)")
    ],
    _request_timeout: Union[
        None,
        Annotated[StrictFloat, Field(gt=0)],
        Tuple[
            Annotated[StrictFloat, Field(gt=0)], Annotated[StrictFloat, Field(gt=0)]
        ],
    ] = None,
    _request_auth: Optional[Dict[StrictStr, Any]] = None,
    _content_type: Optional[StrictStr] = None,
    _headers: Optional[Dict[StrictStr, Any]] = None,
    _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
) -> RESTResponseType:
    """Reverse geocode coordinates

    Retrieve location information (e.g., city, country) for given latitude and longitude coordinates.

    :param lat: Latitude (-90 to 90) (required)
    :type lat: float
    :param lon: Longitude (-180 to 180) (required)
    :type lon: float
    :param _request_timeout: timeout setting for this request. If one
                             number provided, it will be total request
                             timeout. It can also be a pair (tuple) of
                             (connection, read) timeouts.
    :type _request_timeout: int, tuple(int, int), optional
    :param _request_auth: set to override the auth_settings for an a single
                          request; this effectively ignores the
                          authentication in the spec for a single request.
    :type _request_auth: dict, optional
    :param _content_type: force content-type for the request.
    :type _content_type: str, Optional
    :param _headers: set to override the headers for a single
                     request; this effectively ignores the headers
                     in the spec for a single request.
    :type _headers: dict, optional
    :param _host_index: set to override the host_index for a single
                        request; this effectively ignores the host_index
                        in the spec for a single request.
    :type _host_index: int, optional
    :return: Returns the result object.
    """  # noqa: E501

    _param = self._reverse_geocode_serialize(
        lat=lat,
        lon=lon,
        _request_auth=_request_auth,
        _content_type=_content_type,
        _headers=_headers,
        _host_index=_host_index,
    )

    _response_types_map: Dict[str, Optional[str]] = {
        "200": "List[MapReverseGeocodeResponseDto]",
    }
    response_data = await self.api_client.call_api(
        *_param, _request_timeout=_request_timeout
    )
    return response_data.response