Skip to content

ApiClient

immichpy.client.generated.api_client.ApiClient

ApiClient(configuration=None, header_name=None, header_value=None, cookie=None)

Generic API client for OpenAPI client library builds.

OpenAPI generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the OpenAPI templates.

Parameters:

Name Type Description Default
configuration

.Configuration object for this client

None
header_name

a header to pass when making calls to the API.

None
header_value

a header value to pass when making calls to the API.

None
cookie

a cookie to include in the header when making calls to the API

None
Source code in immichpy/client/generated/api_client.py
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def __init__(
    self, configuration=None, header_name=None, header_value=None, cookie=None
) -> None:
    # use default configuration if none is provided
    if configuration is None:
        configuration = Configuration.get_default()
    self.configuration = configuration

    self.rest_client = rest.RESTClientObject(configuration)
    self.default_headers = {}
    if header_name is not None:
        self.default_headers[header_name] = header_value
    self.cookie = cookie
    # Set default User-Agent.
    self.user_agent = "OpenAPI-Generator/1.0.0/python"
    self.client_side_validation = configuration.client_side_validation

user_agent property writable

user_agent

User agent for this API client

__deserialize

__deserialize(data, klass)

Deserializes dict, list, str into an object.

Parameters:

Name Type Description Default
data

dict, list or str.

required
klass

class literal, or string of class name.

required

Returns:

Type Description

object.

Source code in immichpy/client/generated/api_client.py
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
def __deserialize(self, data, klass):
    """Deserializes dict, list, str into an object.

    :param data: dict, list or str.
    :param klass: class literal, or string of class name.

    :return: object.
    """
    if data is None:
        return None

    if isinstance(klass, str):
        if klass.startswith("Optional["):
            m = re.match(r"Optional\[(.*)]", klass)
            assert m is not None, "Malformed Optional type definition"
            # data is not None here, so the optionality is already resolved
            return self.__deserialize(data, m.group(1))

        if klass.startswith("List["):
            m = re.match(r"List\[(.*)]", klass)
            assert m is not None, "Malformed List type definition"
            sub_kls = m.group(1)
            return [self.__deserialize(sub_data, sub_kls) for sub_data in data]

        if klass.startswith("Dict["):
            m = re.match(r"Dict\[([^,]*), (.*)]", klass)
            assert m is not None, "Malformed Dict type definition"
            sub_kls = m.group(2)
            return {k: self.__deserialize(v, sub_kls) for k, v in data.items()}

        # convert str to class
        if klass in self.NATIVE_TYPES_MAPPING:
            klass = self.NATIVE_TYPES_MAPPING[klass]
        else:
            klass = getattr(immichpy.client.generated.models, klass)

    if klass in self.PRIMITIVE_TYPES:
        return self.__deserialize_primitive(data, klass)
    elif klass is object:
        return self.__deserialize_object(data)
    elif klass is datetime.date:
        return self.__deserialize_date(data)
    elif klass is datetime.datetime:
        return self.__deserialize_datetime(data)
    elif klass is decimal.Decimal:
        return decimal.Decimal(data)
    elif klass is uuid.UUID:
        return uuid.UUID(data)
    elif issubclass(klass, Enum):
        return self.__deserialize_enum(data, klass)
    else:
        return self.__deserialize_model(data, klass)

__deserialize_date

__deserialize_date(string)

Deserializes string to date.

Parameters:

Name Type Description Default
string

str.

required

Returns:

Type Description

date.

Source code in immichpy/client/generated/api_client.py
769
770
771
772
773
774
775
776
777
778
779
780
781
782
def __deserialize_date(self, string):
    """Deserializes string to date.

    :param string: str.
    :return: date.
    """
    try:
        return parse(string).date()
    except ImportError:
        return string
    except ValueError:
        raise rest.ApiException(
            status=0, reason="Failed to parse `{0}` as date object".format(string)
        )

__deserialize_datetime

__deserialize_datetime(string)

Deserializes string to datetime.

The string should be in iso8601 datetime format.

Parameters:

Name Type Description Default
string

str.

required

Returns:

Type Description

datetime.

Source code in immichpy/client/generated/api_client.py
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
def __deserialize_datetime(self, string):
    """Deserializes string to datetime.

    The string should be in iso8601 datetime format.

    :param string: str.
    :return: datetime.
    """
    try:
        return parse(string)
    except ImportError:
        return string
    except ValueError:
        raise rest.ApiException(
            status=0,
            reason=("Failed to parse `{0}` as datetime object".format(string)),
        )

__deserialize_enum

__deserialize_enum(data, klass)

Deserializes primitive type to enum.

Parameters:

Name Type Description Default
data

primitive type.

required
klass

class literal.

required

Returns:

Type Description

enum value.

Source code in immichpy/client/generated/api_client.py
802
803
804
805
806
807
808
809
810
811
812
813
814
def __deserialize_enum(self, data, klass):
    """Deserializes primitive type to enum.

    :param data: primitive type.
    :param klass: class literal.
    :return: enum value.
    """
    try:
        return klass(data)
    except ValueError:
        raise rest.ApiException(
            status=0, reason=("Failed to parse `{0}` as `{1}`".format(data, klass))
        )

__deserialize_file

__deserialize_file(response)

Deserializes body to file

Saves response body into a file in a temporary folder, using the filename from the Content-Disposition header if provided.

handle file downloading save response body into a tmp file and return the instance

Parameters:

Name Type Description Default
response

RESTResponse.

required

Returns:

Type Description

file path.

Source code in immichpy/client/generated/api_client.py
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
def __deserialize_file(self, response):
    """Deserializes body to file

    Saves response body into a file in a temporary folder,
    using the filename from the `Content-Disposition` header if provided.

    handle file downloading
    save response body into a tmp file and return the instance

    :param response:  RESTResponse.
    :return: file path.
    """
    fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path)
    os.close(fd)
    os.remove(path)

    content_disposition = response.headers.get("Content-Disposition")
    if content_disposition:
        m = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', content_disposition)
        assert m is not None, "Unexpected 'content-disposition' header value"
        filename = os.path.basename(m.group(1))  # Strip any directory traversal
        if filename in ("", ".", ".."):  # fall back to tmp filename
            filename = os.path.basename(path)
        path = os.path.join(os.path.dirname(path), filename)

    with open(path, "wb") as f:
        f.write(response.data)

    return path

__deserialize_model

__deserialize_model(data, klass)

Deserializes list or dict to model.

Parameters:

Name Type Description Default
data

dict, list.

required
klass

class literal.

required

Returns:

Type Description

model object.

Source code in immichpy/client/generated/api_client.py
816
817
818
819
820
821
822
823
824
def __deserialize_model(self, data, klass):
    """Deserializes list or dict to model.

    :param data: dict, list.
    :param klass: class literal.
    :return: model object.
    """

    return klass.from_dict(data)

__deserialize_object

__deserialize_object(value)

Return an original value.

Returns:

Type Description

object.

Source code in immichpy/client/generated/api_client.py
762
763
764
765
766
767
def __deserialize_object(self, value):
    """Return an original value.

    :return: object.
    """
    return value

__deserialize_primitive

__deserialize_primitive(data, klass)

Deserializes string to primitive type.

Parameters:

Name Type Description Default
data

str.

required
klass

class literal.

required

Returns:

Type Description

int, long, float, str, bool.

Source code in immichpy/client/generated/api_client.py
747
748
749
750
751
752
753
754
755
756
757
758
759
760
def __deserialize_primitive(self, data, klass):
    """Deserializes string to primitive type.

    :param data: str.
    :param klass: class literal.

    :return: int, long, float, str, bool.
    """
    try:
        return klass(data)
    except UnicodeEncodeError:
        return str(data)
    except TypeError:
        return data

call_api async

call_api(method, url, header_params=None, body=None, post_params=None, _request_timeout=None) -> rest.RESTResponse

Makes the HTTP request (synchronous)

Parameters:

Name Type Description Default
method

Method to call.

required
url

Path to method endpoint.

required
header_params

Header parameters to be placed in the request header.

None
body

Request body.

None
dict post_params

Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.

required
_request_timeout

timeout setting for this request.

None

Returns:

Type Description
RESTResponse

RESTResponse

Source code in immichpy/client/generated/api_client.py
237
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
async def call_api(
    self,
    method,
    url,
    header_params=None,
    body=None,
    post_params=None,
    _request_timeout=None,
) -> rest.RESTResponse:
    """Makes the HTTP request (synchronous)
    :param method: Method to call.
    :param url: Path to method endpoint.
    :param header_params: Header parameters to be
        placed in the request header.
    :param body: Request body.
    :param post_params dict: Request post form parameters,
        for `application/x-www-form-urlencoded`, `multipart/form-data`.
    :param _request_timeout: timeout setting for this request.
    :return: RESTResponse
    """

    try:
        # perform request and return response
        response_data = await self.rest_client.request(
            method,
            url,
            headers=header_params,
            body=body,
            post_params=post_params,
            _request_timeout=_request_timeout,
        )

    except ApiException as e:
        raise e

    return response_data

deserialize

deserialize(response_text: str, response_type: str, content_type: Optional[str])

Deserializes response into an object.

Parameters:

Name Type Description Default
response

RESTResponse object to be deserialized.

required
response_type str

class literal for deserialized object, or string of class name.

required
content_type Optional[str]

content type of response.

required

Returns:

Type Description

deserialized object.

Source code in immichpy/client/generated/api_client.py
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
def deserialize(
    self, response_text: str, response_type: str, content_type: Optional[str]
):
    """Deserializes response into an object.

    :param response: RESTResponse object to be deserialized.
    :param response_type: class literal for
        deserialized object, or string of class name.
    :param content_type: content type of response.

    :return: deserialized object.
    """

    # fetch data from response object
    if content_type is None:
        try:
            data = json.loads(response_text)
        except ValueError:
            data = response_text
    elif re.match(
        r"^application/(json|[\w!#$&.+\-^_]+\+json)\s*(;|$)",
        content_type,
        re.IGNORECASE,
    ):
        if response_text == "":
            data = ""
        else:
            data = json.loads(response_text)
    elif re.match(r"^text\/[a-z.+-]+\s*(;|$)", content_type, re.IGNORECASE):
        data = response_text
    else:
        raise ApiException(
            status=0, reason="Unsupported content type: {0}".format(content_type)
        )

    return self.__deserialize(data, response_type)

files_parameters

files_parameters(files: Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes]]])

Builds form parameters.

Parameters:

Name Type Description Default
files Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes]]]

File parameters.

required

Returns:

Type Description

Form parameters with files.

Source code in immichpy/client/generated/api_client.py
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
def files_parameters(
    self,
    files: Dict[str, Union[str, bytes, List[str], List[bytes], Tuple[str, bytes]]],
):
    """Builds form parameters.

    :param files: File parameters.
    :return: Form parameters with files.
    """
    params = []
    for k, v in files.items():
        if isinstance(v, str):
            with open(v, "rb") as f:
                filename = os.path.basename(f.name)
                filedata = f.read()
        elif isinstance(v, bytes):
            filename = k
            filedata = v
        elif isinstance(v, tuple):
            filename, filedata = v
        elif isinstance(v, list):
            for file_param in v:
                params.extend(self.files_parameters({k: file_param}))
            continue
        else:
            raise ValueError("Unsupported file value")
        mimetype = mimetypes.guess_type(filename)[0] or "application/octet-stream"
        params.append(tuple([k, tuple([filename, filedata, mimetype])]))
    return params

get_default classmethod

get_default()

Return new instance of ApiClient.

This method returns newly created, based on default constructor, object of ApiClient class or returns a copy of default ApiClient.

Returns:

Type Description

The ApiClient object.

Source code in immichpy/client/generated/api_client.py
115
116
117
118
119
120
121
122
123
124
125
126
127
@classmethod
def get_default(cls):
    """Return new instance of ApiClient.

    This method returns newly created, based on default constructor,
    object of ApiClient class or returns a copy of default
    ApiClient.

    :return: The ApiClient object.
    """
    if cls._default is None:
        cls._default = ApiClient()
    return cls._default

param_serialize

param_serialize(method, resource_path, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, auth_settings=None, collection_formats=None, _host=None, _request_auth=None) -> RequestSerialized

Builds the HTTP request params needed by the request.

Parameters:

Name Type Description Default
method

Method to call.

required
resource_path

Path to method endpoint.

required
path_params

Path parameters in the url.

None
query_params

Query parameters in the url.

None
header_params

Header parameters to be placed in the request header.

None
body

Request body.

None
dict post_params

Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.

required
list auth_settings

Auth Settings names for the request.

required
collection_formats

dict of collection formats for path, query, header, and post parameters.

None
_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.

None

Returns:

Type Description
RequestSerialized

tuple of form (path, http_method, query_params, header_params, body, post_params, files)

Source code in immichpy/client/generated/api_client.py
139
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
def param_serialize(
    self,
    method,
    resource_path,
    path_params=None,
    query_params=None,
    header_params=None,
    body=None,
    post_params=None,
    files=None,
    auth_settings=None,
    collection_formats=None,
    _host=None,
    _request_auth=None,
) -> RequestSerialized:
    """Builds the HTTP request params needed by the request.
    :param method: Method to call.
    :param resource_path: Path to method endpoint.
    :param path_params: Path parameters in the url.
    :param query_params: Query parameters in the url.
    :param header_params: Header parameters to be
        placed in the request header.
    :param body: Request body.
    :param post_params dict: Request post form parameters,
        for `application/x-www-form-urlencoded`, `multipart/form-data`.
    :param auth_settings list: Auth Settings names for the request.
    :param files dict: key -> filename, value -> filepath,
        for `multipart/form-data`.
    :param collection_formats: dict of collection formats for path, query,
        header, and post parameters.
    :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.
    :return: tuple of form (path, http_method, query_params, header_params,
        body, post_params, files)
    """

    config = self.configuration

    # header parameters
    header_params = header_params or {}
    header_params.update(self.default_headers)
    if self.cookie:
        header_params["Cookie"] = self.cookie
    if header_params:
        header_params = self.sanitize_for_serialization(header_params)
        header_params = dict(
            self.parameters_to_tuples(header_params, collection_formats)
        )

    # path parameters
    if path_params:
        path_params = self.sanitize_for_serialization(path_params)
        path_params = self.parameters_to_tuples(path_params, collection_formats)
        for k, v in path_params:
            # specified safe chars, encode everything
            resource_path = resource_path.replace(
                "{%s}" % k, quote(str(v), safe=config.safe_chars_for_path_param)
            )

    # post parameters
    if post_params or files:
        post_params = post_params if post_params else []
        post_params = self.sanitize_for_serialization(post_params)
        post_params = self.parameters_to_tuples(post_params, collection_formats)
        if files:
            post_params.extend(self.files_parameters(files))

    # auth setting
    self.update_params_for_auth(
        header_params,
        query_params,
        auth_settings,
        resource_path,
        method,
        body,
        request_auth=_request_auth,
    )

    # body
    if body:
        body = self.sanitize_for_serialization(body)

    # request url
    if _host is None or self.configuration.ignore_operation_servers:
        url = self.configuration.host + resource_path
    else:
        # use server/host defined in path or operation instead
        url = _host + resource_path

    # query parameters
    if query_params:
        query_params = self.sanitize_for_serialization(query_params)
        url_query = self.parameters_to_url_query(query_params, collection_formats)
        url += "?" + url_query

    return method, url, header_params, body, post_params

parameters_to_tuples

parameters_to_tuples(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters:

Name Type Description Default
params

Parameters as dict or list of two-tuples

required
collection_formats dict

Parameter collection formats

required

Returns:

Type Description

Parameters as list of tuples, collections formatted

Source code in immichpy/client/generated/api_client.py
486
487
488
489
490
491
492
493
494
495
496
497
498
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
def parameters_to_tuples(self, params, collection_formats):
    """Get parameters as list of tuples, formatting collections.

    :param params: Parameters as dict or list of two-tuples
    :param dict collection_formats: Parameter collection formats
    :return: Parameters as list of tuples, collections formatted
    """
    new_params: List[Tuple[str, str]] = []
    if collection_formats is None:
        collection_formats = {}
    for k, v in params.items() if isinstance(params, dict) else params:
        if isinstance(v, bool):
            v = str(v).lower()
        if k in collection_formats:
            collection_format = collection_formats[k]
            if collection_format == "multi":
                new_params.extend(
                    (k, str(value).lower() if isinstance(value, bool) else value)
                    for value in v
                )
            else:
                if collection_format == "ssv":
                    delimiter = " "
                elif collection_format == "tsv":
                    delimiter = "\t"
                elif collection_format == "pipes":
                    delimiter = "|"
                else:  # csv is the default
                    delimiter = ","
                new_params.append(
                    (
                        k,
                        delimiter.join(
                            str(value).lower()
                            if isinstance(value, bool)
                            else str(value)
                            for value in v
                        ),
                    )
                )
        else:
            new_params.append((k, v))
    return new_params

parameters_to_url_query

parameters_to_url_query(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters:

Name Type Description Default
params

Parameters as dict or list of two-tuples

required
collection_formats dict

Parameter collection formats

required

Returns:

Type Description

URL query string (e.g. a=Hello%20World&b=123)

Source code in immichpy/client/generated/api_client.py
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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
def parameters_to_url_query(self, params, collection_formats):
    """Get parameters as list of tuples, formatting collections.

    :param params: Parameters as dict or list of two-tuples
    :param dict collection_formats: Parameter collection formats
    :return: URL query string (e.g. a=Hello%20World&b=123)
    """
    new_params: List[Tuple[str, str]] = []
    if collection_formats is None:
        collection_formats = {}
    for k, v in params.items() if isinstance(params, dict) else params:
        if isinstance(v, bool):
            v = str(v).lower()
        if isinstance(v, (int, float)):
            v = str(v)
        if isinstance(v, dict):
            v = json.dumps(v)

        if k in collection_formats:
            collection_format = collection_formats[k]
            if collection_format == "multi":
                new_params.extend(
                    (
                        k,
                        quote(
                            str(value).lower()
                            if isinstance(value, bool)
                            else str(value)
                        ),
                    )
                    for value in v
                )
            else:
                if collection_format == "ssv":
                    delimiter = " "
                elif collection_format == "tsv":
                    delimiter = "\t"
                elif collection_format == "pipes":
                    delimiter = "|"
                else:  # csv is the default
                    delimiter = ","
                new_params.append(
                    (
                        k,
                        delimiter.join(
                            quote(
                                str(value).lower()
                                if isinstance(value, bool)
                                else str(value)
                            )
                            for value in v
                        ),
                    )
                )
        else:
            new_params.append((k, quote(str(v))))

    return "&".join(["=".join(map(str, item)) for item in new_params])

response_deserialize

response_deserialize(response_data: RESTResponse, response_types_map: Optional[Dict[str, T]] = None) -> ApiResponse[ApiResponseT]

Deserializes response into an object.

Parameters:

Name Type Description Default
response_data RESTResponse

RESTResponse object to be deserialized.

required
response_types_map Optional[Dict[str, T]]

dict of response types.

None

Returns:

Type Description
ApiResponse[T]

ApiResponse

Source code in immichpy/client/generated/api_client.py
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
331
332
333
334
335
336
337
338
339
340
341
342
343
def response_deserialize(
    self,
    response_data: rest.RESTResponse,
    response_types_map: Optional[Dict[str, ApiResponseT]] = None,
) -> ApiResponse[ApiResponseT]:
    """Deserializes response into an object.
    :param response_data: RESTResponse object to be deserialized.
    :param response_types_map: dict of response types.
    :return: ApiResponse
    """

    msg = "RESTResponse.read() must be called before passing it to response_deserialize()"
    assert response_data.data is not None, msg

    response_type = response_types_map.get(str(response_data.status), None)
    if (
        not response_type
        and isinstance(response_data.status, int)
        and 100 <= response_data.status <= 599
    ):
        # if not found, look for '1XX', '2XX', etc.
        response_type = response_types_map.get(
            str(response_data.status)[0] + "XX", None
        )

    # If the response_type has not matched (eg. did not match the previous if statements) and the default response is available, use it.
    if (
        response_type is None
        and str(response_data.status) not in response_types_map
        and (
            not isinstance(response_data.status, int)
            or not 100 <= response_data.status <= 599
            or str(response_data.status)[0] + "XX" not in response_types_map
        )
        and "default" in response_types_map
    ):
        response_type = response_types_map["default"]

    # deserialize response data
    response_text = None
    return_data = None
    try:
        if response_type in ("bytearray", "bytes"):
            return_data = response_data.data
        elif response_type == "file":
            return_data = self.__deserialize_file(response_data)
        elif response_type is not None:
            match = None
            content_type = response_data.headers.get("content-type")
            if content_type is not None:
                match = re.search(r"charset=([a-zA-Z\-\d]+)[\s;]?", content_type)
            encoding = match.group(1) if match else "utf-8"
            response_text = response_data.data.decode(encoding)
            return_data = self.deserialize(
                response_text, response_type, content_type
            )
    finally:
        if not 200 <= response_data.status <= 299:
            raise ApiException.from_response(
                http_resp=response_data,
                body=response_text,
                data=return_data,
            )

    return ApiResponse(
        status_code=response_data.status,
        data=return_data,
        headers=response_data.headers,
        raw_data=response_data.data,
    )

sanitize_for_serialization

sanitize_for_serialization(obj)

Builds a JSON POST object.

If obj is None, return None. If obj is SecretStr, return obj.get_secret_value() If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date convert to string in iso8601 format. If obj is decimal.Decimal return string representation. If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is OpenAPI model, return the properties dict.

Parameters:

Name Type Description Default
obj

The data to serialize.

required

Returns:

Type Description

The serialized form of data.

Source code in immichpy/client/generated/api_client.py
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
def sanitize_for_serialization(self, obj):
    """Builds a JSON POST object.

    If obj is None, return None.
    If obj is SecretStr, return obj.get_secret_value()
    If obj is str, int, long, float, bool, return directly.
    If obj is datetime.datetime, datetime.date
        convert to string in iso8601 format.
    If obj is decimal.Decimal return string representation.
    If obj is list, sanitize each element in the list.
    If obj is dict, return the dict.
    If obj is OpenAPI model, return the properties dict.

    :param obj: The data to serialize.
    :return: The serialized form of data.
    """
    if obj is None:
        return None
    elif isinstance(obj, Enum):
        return obj.value
    elif isinstance(obj, SecretStr):
        return obj.get_secret_value()
    elif isinstance(obj, self.PRIMITIVE_TYPES):
        return obj
    elif isinstance(obj, uuid.UUID):
        return str(obj)
    elif isinstance(obj, list):
        return [self.sanitize_for_serialization(sub_obj) for sub_obj in obj]
    elif isinstance(obj, tuple):
        return tuple(self.sanitize_for_serialization(sub_obj) for sub_obj in obj)
    elif isinstance(obj, (datetime.datetime, datetime.date)):
        return obj.isoformat()
    elif isinstance(obj, decimal.Decimal):
        return str(obj)
    elif isinstance(obj, dict):
        return {
            key: self.sanitize_for_serialization(val) for key, val in obj.items()
        }

    # Convert model obj to dict except
    # attributes `openapi_types`, `attribute_map`
    # and attributes which value is not None.
    # Convert attribute name to json key in
    # model definition for request.
    if hasattr(obj, "to_dict") and callable(getattr(obj, "to_dict")):
        obj_dict = obj.to_dict()
    else:
        obj_dict = obj.__dict__

    return self.sanitize_for_serialization(obj_dict)

select_header_accept

select_header_accept(accepts: List[str]) -> Optional[str]

Returns Accept based on an array of accepts provided.

Parameters:

Name Type Description Default
accepts List[str]

List of headers.

required

Returns:

Type Description
Optional[str]

Accept (e.g. application/json).

Source code in immichpy/client/generated/api_client.py
619
620
621
622
623
624
625
626
627
628
629
630
631
632
def select_header_accept(self, accepts: List[str]) -> Optional[str]:
    """Returns `Accept` based on an array of accepts provided.

    :param accepts: List of headers.
    :return: Accept (e.g. application/json).
    """
    if not accepts:
        return None

    for accept in accepts:
        if re.search("json", accept, re.IGNORECASE):
            return accept

    return accepts[0]

select_header_content_type

select_header_content_type(content_types)

Returns Content-Type based on an array of content_types provided.

Parameters:

Name Type Description Default
content_types

List of content-types.

required

Returns:

Type Description

Content-Type (e.g. application/json).

Source code in immichpy/client/generated/api_client.py
634
635
636
637
638
639
640
641
642
643
644
645
646
647
def select_header_content_type(self, content_types):
    """Returns `Content-Type` based on an array of content_types provided.

    :param content_types: List of content-types.
    :return: Content-Type (e.g. application/json).
    """
    if not content_types:
        return None

    for content_type in content_types:
        if re.search("json", content_type, re.IGNORECASE):
            return content_type

    return content_types[0]

set_default classmethod

set_default(default)

Set default instance of ApiClient.

It stores default ApiClient.

Parameters:

Name Type Description Default
default

object of ApiClient.

required
Source code in immichpy/client/generated/api_client.py
129
130
131
132
133
134
135
136
137
@classmethod
def set_default(cls, default):
    """Set default instance of ApiClient.

    It stores default ApiClient.

    :param default: object of ApiClient.
    """
    cls._default = default

update_params_for_auth

update_params_for_auth(headers, queries, auth_settings, resource_path, method, body, request_auth=None) -> None

Updates header and query params based on authentication setting.

:resource_path: A string representation of the HTTP request resource path. :method: A string representation of the HTTP request method. :body: A object representing the body of the HTTP request. The object type is the return value of sanitize_for_serialization().

Parameters:

Name Type Description Default
headers

Header parameters dict to be updated.

required
queries

Query parameters tuple list to be updated.

required
auth_settings

Authentication setting identifiers list.

required
request_auth

if set, the provided settings will override the token in the configuration.

None
Source code in immichpy/client/generated/api_client.py
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
def update_params_for_auth(
    self,
    headers,
    queries,
    auth_settings,
    resource_path,
    method,
    body,
    request_auth=None,
) -> None:
    """Updates header and query params based on authentication setting.

    :param headers: Header parameters dict to be updated.
    :param queries: Query parameters tuple list to be updated.
    :param auth_settings: Authentication setting identifiers list.
    :resource_path: A string representation of the HTTP request resource path.
    :method: A string representation of the HTTP request method.
    :body: A object representing the body of the HTTP request.
    The object type is the return value of sanitize_for_serialization().
    :param request_auth: if set, the provided settings will
                         override the token in the configuration.
    """
    if not auth_settings:
        return

    if request_auth:
        self._apply_auth_params(
            headers, queries, resource_path, method, body, request_auth
        )
    else:
        for auth in auth_settings:
            auth_setting = self.configuration.auth_settings().get(auth)
            if auth_setting:
                self._apply_auth_params(
                    headers, queries, resource_path, method, body, auth_setting
                )