immichpy 1.6.5__py3-none-any.whl → 1.7.5__py3-none-any.whl

immichpy/client/generated/api/server_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/api/sessions_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/api/shared_links_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -593,7 +593,12 @@ class SharedLinksApi:
     @validate_call
     async def get_all_shared_links(
         self,
-        album_id: Optional[UUID] = None,
+        album_id: Annotated[
+            Optional[UUID], Field(description="Filter by album ID")
+        ] = None,
+        id: Annotated[
+            Optional[UUID], Field(description="Filter by shared link ID")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -610,8 +615,10 @@ class SharedLinksApi:
 
         Retrieve a list of all shared links.
 
-        :param album_id:
+        :param album_id: Filter by album ID
         :type album_id: UUID
+        :param id: Filter by shared link ID
+        :type id: UUID
         :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
@@ -636,6 +643,7 @@ class SharedLinksApi:
 
         _param = self._get_all_shared_links_serialize(
             album_id=album_id,
+            id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -657,7 +665,12 @@ class SharedLinksApi:
     @validate_call
     async def get_all_shared_links_with_http_info(
         self,
-        album_id: Optional[UUID] = None,
+        album_id: Annotated[
+            Optional[UUID], Field(description="Filter by album ID")
+        ] = None,
+        id: Annotated[
+            Optional[UUID], Field(description="Filter by shared link ID")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -674,8 +687,10 @@ class SharedLinksApi:
 
         Retrieve a list of all shared links.
 
-        :param album_id:
+        :param album_id: Filter by album ID
         :type album_id: UUID
+        :param id: Filter by shared link ID
+        :type id: UUID
         :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
@@ -700,6 +715,7 @@ class SharedLinksApi:
 
         _param = self._get_all_shared_links_serialize(
             album_id=album_id,
+            id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -721,7 +737,12 @@ class SharedLinksApi:
     @validate_call
     async def get_all_shared_links_without_preload_content(
         self,
-        album_id: Optional[UUID] = None,
+        album_id: Annotated[
+            Optional[UUID], Field(description="Filter by album ID")
+        ] = None,
+        id: Annotated[
+            Optional[UUID], Field(description="Filter by shared link ID")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -738,8 +759,10 @@ class SharedLinksApi:
 
         Retrieve a list of all shared links.
 
-        :param album_id:
+        :param album_id: Filter by album ID
         :type album_id: UUID
+        :param id: Filter by shared link ID
+        :type id: UUID
         :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
@@ -764,6 +787,7 @@ class SharedLinksApi:
 
         _param = self._get_all_shared_links_serialize(
             album_id=album_id,
+            id=id,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -781,6 +805,7 @@ class SharedLinksApi:
     def _get_all_shared_links_serialize(
         self,
         album_id,
+        id,
         _request_auth,
         _content_type,
         _headers,
@@ -804,6 +829,9 @@ class SharedLinksApi:
         if album_id is not None:
             _query_params.append(("albumId", album_id))
 
+        if id is not None:
+            _query_params.append(("id", id))
+
         # process the header parameters
         # process the form parameters
         # process the body parameter
@@ -836,9 +864,11 @@ class SharedLinksApi:
     async def get_my_shared_link(
         self,
         key: Optional[StrictStr] = None,
-        password: Optional[StrictStr] = None,
+        password: Annotated[
+            Optional[StrictStr], Field(description="Link password")
+        ] = None,
         slug: Optional[StrictStr] = None,
-        token: Optional[StrictStr] = None,
+        token: Annotated[Optional[StrictStr], Field(description="Access token")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -857,11 +887,11 @@ class SharedLinksApi:
 
         :param key:
         :type key: str
-        :param password:
+        :param password: Link password
         :type password: str
         :param slug:
         :type slug: str
-        :param token:
+        :param token: Access token
         :type token: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -912,9 +942,11 @@ class SharedLinksApi:
     async def get_my_shared_link_with_http_info(
         self,
         key: Optional[StrictStr] = None,
-        password: Optional[StrictStr] = None,
+        password: Annotated[
+            Optional[StrictStr], Field(description="Link password")
+        ] = None,
         slug: Optional[StrictStr] = None,
-        token: Optional[StrictStr] = None,
+        token: Annotated[Optional[StrictStr], Field(description="Access token")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -933,11 +965,11 @@ class SharedLinksApi:
 
         :param key:
         :type key: str
-        :param password:
+        :param password: Link password
         :type password: str
         :param slug:
         :type slug: str
-        :param token:
+        :param token: Access token
         :type token: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -988,9 +1020,11 @@ class SharedLinksApi:
     async def get_my_shared_link_without_preload_content(
         self,
         key: Optional[StrictStr] = None,
-        password: Optional[StrictStr] = None,
+        password: Annotated[
+            Optional[StrictStr], Field(description="Link password")
+        ] = None,
         slug: Optional[StrictStr] = None,
-        token: Optional[StrictStr] = None,
+        token: Annotated[Optional[StrictStr], Field(description="Access token")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1009,11 +1043,11 @@ class SharedLinksApi:
 
         :param key:
         :type key: str
-        :param password:
+        :param password: Link password
         :type password: str
         :param slug:
         :type slug: str
-        :param token:
+        :param token: Access token
         :type token: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

immichpy/client/generated/api/stacks_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -1263,7 +1263,9 @@ class StacksApi:
     @validate_call
     async def search_stacks(
         self,
-        primary_asset_id: Optional[UUID] = None,
+        primary_asset_id: Annotated[
+            Optional[UUID], Field(description="Filter by primary asset ID")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1280,7 +1282,7 @@ class StacksApi:
 
         Retrieve a list of stacks.
 
-        :param primary_asset_id:
+        :param primary_asset_id: Filter by primary asset ID
         :type primary_asset_id: UUID
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1327,7 +1329,9 @@ class StacksApi:
     @validate_call
     async def search_stacks_with_http_info(
         self,
-        primary_asset_id: Optional[UUID] = None,
+        primary_asset_id: Annotated[
+            Optional[UUID], Field(description="Filter by primary asset ID")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1344,7 +1348,7 @@ class StacksApi:
 
         Retrieve a list of stacks.
 
-        :param primary_asset_id:
+        :param primary_asset_id: Filter by primary asset ID
         :type primary_asset_id: UUID
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1391,7 +1395,9 @@ class StacksApi:
     @validate_call
     async def search_stacks_without_preload_content(
         self,
-        primary_asset_id: Optional[UUID] = None,
+        primary_asset_id: Annotated[
+            Optional[UUID], Field(description="Filter by primary asset ID")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1408,7 +1414,7 @@ class StacksApi:
 
         Retrieve a list of stacks.
 
-        :param primary_asset_id:
+        :param primary_asset_id: Filter by primary asset ID
         :type primary_asset_id: UUID
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

immichpy/client/generated/api/sync_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/api/system_config_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/api/system_metadata_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/api/tags_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/api/timeline_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/api/trash_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/api/users_admin_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -1296,9 +1296,15 @@ class UsersAdminApi:
     async def get_user_statistics_admin(
         self,
         id: UUID,
-        is_favorite: Optional[StrictBool] = None,
-        is_trashed: Optional[StrictBool] = None,
-        visibility: Optional[AssetVisibility] = None,
+        is_favorite: Annotated[
+            Optional[StrictBool], Field(description="Filter by favorite status")
+        ] = None,
+        is_trashed: Annotated[
+            Optional[StrictBool], Field(description="Filter by trash status")
+        ] = None,
+        visibility: Annotated[
+            Optional[AssetVisibility], Field(description="Filter by visibility")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1317,11 +1323,11 @@ class UsersAdminApi:
 
         :param id: (required)
         :type id: UUID
-        :param is_favorite:
+        :param is_favorite: Filter by favorite status
         :type is_favorite: bool
-        :param is_trashed:
+        :param is_trashed: Filter by trash status
         :type is_trashed: bool
-        :param visibility:
+        :param visibility: Filter by visibility
         :type visibility: AssetVisibility
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1372,9 +1378,15 @@ class UsersAdminApi:
     async def get_user_statistics_admin_with_http_info(
         self,
         id: UUID,
-        is_favorite: Optional[StrictBool] = None,
-        is_trashed: Optional[StrictBool] = None,
-        visibility: Optional[AssetVisibility] = None,
+        is_favorite: Annotated[
+            Optional[StrictBool], Field(description="Filter by favorite status")
+        ] = None,
+        is_trashed: Annotated[
+            Optional[StrictBool], Field(description="Filter by trash status")
+        ] = None,
+        visibility: Annotated[
+            Optional[AssetVisibility], Field(description="Filter by visibility")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1393,11 +1405,11 @@ class UsersAdminApi:
 
         :param id: (required)
         :type id: UUID
-        :param is_favorite:
+        :param is_favorite: Filter by favorite status
         :type is_favorite: bool
-        :param is_trashed:
+        :param is_trashed: Filter by trash status
         :type is_trashed: bool
-        :param visibility:
+        :param visibility: Filter by visibility
         :type visibility: AssetVisibility
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1448,9 +1460,15 @@ class UsersAdminApi:
     async def get_user_statistics_admin_without_preload_content(
         self,
         id: UUID,
-        is_favorite: Optional[StrictBool] = None,
-        is_trashed: Optional[StrictBool] = None,
-        visibility: Optional[AssetVisibility] = None,
+        is_favorite: Annotated[
+            Optional[StrictBool], Field(description="Filter by favorite status")
+        ] = None,
+        is_trashed: Annotated[
+            Optional[StrictBool], Field(description="Filter by trash status")
+        ] = None,
+        visibility: Annotated[
+            Optional[AssetVisibility], Field(description="Filter by visibility")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1469,11 +1487,11 @@ class UsersAdminApi:
 
         :param id: (required)
         :type id: UUID
-        :param is_favorite:
+        :param is_favorite: Filter by favorite status
         :type is_favorite: bool
-        :param is_trashed:
+        :param is_trashed: Filter by trash status
         :type is_trashed: bool
-        :param visibility:
+        :param visibility: Filter by visibility
         :type visibility: AssetVisibility
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1825,8 +1843,10 @@ class UsersAdminApi:
     @validate_call
     async def search_users_admin(
         self,
-        id: Optional[UUID] = None,
-        with_deleted: Optional[StrictBool] = None,
+        id: Annotated[Optional[UUID], Field(description="User ID filter")] = None,
+        with_deleted: Annotated[
+            Optional[StrictBool], Field(description="Include deleted users")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1843,9 +1863,9 @@ class UsersAdminApi:
 
         Search for users.
 
-        :param id:
+        :param id: User ID filter
         :type id: UUID
-        :param with_deleted:
+        :param with_deleted: Include deleted users
         :type with_deleted: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1893,8 +1913,10 @@ class UsersAdminApi:
     @validate_call
     async def search_users_admin_with_http_info(
         self,
-        id: Optional[UUID] = None,
-        with_deleted: Optional[StrictBool] = None,
+        id: Annotated[Optional[UUID], Field(description="User ID filter")] = None,
+        with_deleted: Annotated[
+            Optional[StrictBool], Field(description="Include deleted users")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1911,9 +1933,9 @@ class UsersAdminApi:
 
         Search for users.
 
-        :param id:
+        :param id: User ID filter
         :type id: UUID
-        :param with_deleted:
+        :param with_deleted: Include deleted users
         :type with_deleted: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1961,8 +1983,10 @@ class UsersAdminApi:
     @validate_call
     async def search_users_admin_without_preload_content(
         self,
-        id: Optional[UUID] = None,
-        with_deleted: Optional[StrictBool] = None,
+        id: Annotated[Optional[UUID], Field(description="User ID filter")] = None,
+        with_deleted: Annotated[
+            Optional[StrictBool], Field(description="Include deleted users")
+        ] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1979,9 +2003,9 @@ class UsersAdminApi:
 
         Search for users.
 
-        :param id:
+        :param id: User ID filter
         :type id: UUID
-        :param with_deleted:
+        :param with_deleted: Include deleted users
         :type with_deleted: bool
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

immichpy/client/generated/api/users_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -58,7 +58,10 @@ class UsersApi:
     @validate_call
     async def create_profile_image(
         self,
-        file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+        file: Annotated[
+            Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+            Field(description="Profile image file"),
+        ],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -75,7 +78,7 @@ class UsersApi:
 
         Upload and set a new profile image for the current user.
 
-        :param file: (required)
+        :param file: Profile image file (required)
         :type file: bytearray
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -122,7 +125,10 @@ class UsersApi:
     @validate_call
     async def create_profile_image_with_http_info(
         self,
-        file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+        file: Annotated[
+            Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+            Field(description="Profile image file"),
+        ],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -139,7 +145,7 @@ class UsersApi:
 
         Upload and set a new profile image for the current user.
 
-        :param file: (required)
+        :param file: Profile image file (required)
         :type file: bytearray
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -186,7 +192,10 @@ class UsersApi:
     @validate_call
     async def create_profile_image_without_preload_content(
         self,
-        file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+        file: Annotated[
+            Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]],
+            Field(description="Profile image file"),
+        ],
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -203,7 +212,7 @@ class UsersApi:
 
         Upload and set a new profile image for the current user.
 
-        :param file: (required)
+        :param file: Profile image file (required)
         :type file: bytearray
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

immichpy/client/generated/api/views_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/api/workflows_api.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/api_client.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.

immichpy/client/generated/configuration.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.
@@ -560,7 +560,7 @@ class Configuration:
             "Python SDK Debug Report:\n"
             "OS: {env}\n"
             "Python Version: {pyversion}\n"
-            "Version of the API: 2.4.1\n"
+            "Version of the API: 2.5.2\n"
             "SDK Package Version: 1.0.0".format(env=sys.platform, pyversion=sys.version)
         )
 

immichpy/client/generated/exceptions.py

@@ -5,7 +5,7 @@ Immich
 
 Immich API
 
-The version of the OpenAPI document: 2.4.1
+The version of the OpenAPI document: 2.5.2
 Generated by OpenAPI Generator (https://openapi-generator.tech)
 
 Do not edit the class manually.