kard-financial-sdk 0.0.82__py3-none-any.whl

kard/files/errors/forbidden_error.py

@@ -0,0 +1,11 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ...commons.types.error_response import ErrorResponse
+from ...core.api_error import ApiError
+
+
+class ForbiddenError(ApiError):
+    def __init__(self, body: ErrorResponse, headers: typing.Optional[typing.Dict[str, str]] = None):
+        super().__init__(status_code=403, headers=headers, body=body)

kard/files/raw_client.py

@@ -0,0 +1,278 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..commons.errors.internal_server_error import InternalServerError
+from ..commons.errors.invalid_request import InvalidRequest
+from ..commons.errors.unauthorized_error import UnauthorizedError
+from ..commons.types.error_response import ErrorResponse
+from ..commons.types.organization_id import OrganizationId
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from .errors.forbidden_error import ForbiddenError
+from .types.file_type import FileType
+from .types.files_metadata_sort_options import FilesMetadataSortOptions
+from .types.get_files_metadata_response import GetFilesMetadataResponse
+
+
+class RawFilesClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_metadata(
+        self,
+        organization_id: OrganizationId,
+        *,
+        filter_date_from: typing.Optional[str] = None,
+        filter_date_to: typing.Optional[str] = None,
+        filter_file_type: typing.Optional[FileType] = None,
+        page_size: typing.Optional[int] = None,
+        page_after: typing.Optional[str] = None,
+        page_before: typing.Optional[str] = None,
+        sort: typing.Optional[typing.Union[FilesMetadataSortOptions, typing.Sequence[FilesMetadataSortOptions]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[GetFilesMetadataResponse]:
+        """
+        Retrieves metadata for files associated with a specific issuer/organization.
+        This endpoint supports pagination and sorting options to efficiently navigate
+        through potentially large sets of file metadata.
+        <b>Required scopes:</b> `files.read`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        filter_date_from : typing.Optional[str]
+            Start date for filtering files (format ISO8601). If not provided, defaults to current date minus 1 month.
+
+        filter_date_to : typing.Optional[str]
+            End date for filtering files (format ISO8601). If not provided, defaults to current date.
+
+        filter_file_type : typing.Optional[FileType]
+            The document file type.
+
+        page_size : typing.Optional[int]
+            Number of items per page. Defaults to 10 if not specified and maximum value allowed 100 items per page.
+
+        page_after : typing.Optional[str]
+            Cursor for forward pagination (next page).
+
+        page_before : typing.Optional[str]
+            Cursor for backward pagination (previous page).
+
+        sort : typing.Optional[typing.Union[FilesMetadataSortOptions, typing.Sequence[FilesMetadataSortOptions]]]
+            If provided, response will be sorted by the specified fields. Defaults to descending sentDate, equivalent to "-sentDate"
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[GetFilesMetadataResponse]
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v2/issuers/{jsonable_encoder(organization_id)}/files/metadata",
+            method="GET",
+            params={
+                "filter[dateFrom]": filter_date_from,
+                "filter[dateTo]": filter_date_to,
+                "filter[fileType]": filter_file_type,
+                "page[size]": page_size,
+                "page[after]": page_after,
+                "page[before]": page_before,
+                "sort": sort,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetFilesMetadataResponse,
+                    parse_obj_as(
+                        type_=GetFilesMetadataResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise InvalidRequest(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawFilesClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_metadata(
+        self,
+        organization_id: OrganizationId,
+        *,
+        filter_date_from: typing.Optional[str] = None,
+        filter_date_to: typing.Optional[str] = None,
+        filter_file_type: typing.Optional[FileType] = None,
+        page_size: typing.Optional[int] = None,
+        page_after: typing.Optional[str] = None,
+        page_before: typing.Optional[str] = None,
+        sort: typing.Optional[typing.Union[FilesMetadataSortOptions, typing.Sequence[FilesMetadataSortOptions]]] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[GetFilesMetadataResponse]:
+        """
+        Retrieves metadata for files associated with a specific issuer/organization.
+        This endpoint supports pagination and sorting options to efficiently navigate
+        through potentially large sets of file metadata.
+        <b>Required scopes:</b> `files.read`
+
+        Parameters
+        ----------
+        organization_id : OrganizationId
+
+        filter_date_from : typing.Optional[str]
+            Start date for filtering files (format ISO8601). If not provided, defaults to current date minus 1 month.
+
+        filter_date_to : typing.Optional[str]
+            End date for filtering files (format ISO8601). If not provided, defaults to current date.
+
+        filter_file_type : typing.Optional[FileType]
+            The document file type.
+
+        page_size : typing.Optional[int]
+            Number of items per page. Defaults to 10 if not specified and maximum value allowed 100 items per page.
+
+        page_after : typing.Optional[str]
+            Cursor for forward pagination (next page).
+
+        page_before : typing.Optional[str]
+            Cursor for backward pagination (previous page).
+
+        sort : typing.Optional[typing.Union[FilesMetadataSortOptions, typing.Sequence[FilesMetadataSortOptions]]]
+            If provided, response will be sorted by the specified fields. Defaults to descending sentDate, equivalent to "-sentDate"
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[GetFilesMetadataResponse]
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v2/issuers/{jsonable_encoder(organization_id)}/files/metadata",
+            method="GET",
+            params={
+                "filter[dateFrom]": filter_date_from,
+                "filter[dateTo]": filter_date_to,
+                "filter[fileType]": filter_file_type,
+                "page[size]": page_size,
+                "page[after]": page_after,
+                "page[before]": page_before,
+                "sort": sort,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetFilesMetadataResponse,
+                    parse_obj_as(
+                        type_=GetFilesMetadataResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 400:
+                raise InvalidRequest(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

kard/files/types/__init__.py

@@ -0,0 +1,53 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .file_metadata_attribute import FileMetadataAttribute
+    from .file_metadata_with_url import FileMetadataWithUrl
+    from .file_type import FileType
+    from .files_metadata_sort_options import FilesMetadataSortOptions
+    from .get_files_metadata_response import GetFilesMetadataResponse
+    from .pagination_meta import PaginationMeta
+_dynamic_imports: typing.Dict[str, str] = {
+    "FileMetadataAttribute": ".file_metadata_attribute",
+    "FileMetadataWithUrl": ".file_metadata_with_url",
+    "FileType": ".file_type",
+    "FilesMetadataSortOptions": ".files_metadata_sort_options",
+    "GetFilesMetadataResponse": ".get_files_metadata_response",
+    "PaginationMeta": ".pagination_meta",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "FileMetadataAttribute",
+    "FileMetadataWithUrl",
+    "FileType",
+    "FilesMetadataSortOptions",
+    "GetFilesMetadataResponse",
+    "PaginationMeta",
+]

kard/files/types/file_metadata_attribute.py

@@ -0,0 +1,39 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class FileMetadataAttribute(UniversalBaseModel):
+    file_name: typing_extensions.Annotated[str, FieldMetadata(alias="fileName")] = pydantic.Field()
+    """
+    The name of the file.
+    """
+
+    sent_at: typing_extensions.Annotated[str, FieldMetadata(alias="sentAt")] = pydantic.Field()
+    """
+    ISO 8601 timestamp (ISO8601) when the file was originally sent/created.
+    """
+
+    last_modified: typing_extensions.Annotated[str, FieldMetadata(alias="lastModified")] = pydantic.Field()
+    """
+    ISO 8601 timestamp (ISO8601) when the file was last modified.
+    """
+
+    download_url: typing_extensions.Annotated[str, FieldMetadata(alias="downloadUrl")] = pydantic.Field()
+    """
+    Temporary URL that provides direct access to download the file for 30 minutes.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

kard/files/types/file_metadata_with_url.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .file_metadata_attribute import FileMetadataAttribute
+from .file_type import FileType
+
+
+class FileMetadataWithUrl(UniversalBaseModel):
+    type: FileType = pydantic.Field()
+    """
+    The type of the generated file.
+    """
+
+    attributes: FileMetadataAttribute = pydantic.Field()
+    """
+    Attributes of the filetype
+    """
+
+    id: str = pydantic.Field()
+    """
+    The File ID in Kard’s system
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

kard/files/types/file_type.py

@@ -0,0 +1,13 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+FileType = typing.Union[
+    typing.Literal[
+        "earnedRewardApprovedDailyReconciliationFile",
+        "earnedRewardSettledDailyReconciliationFile",
+        "validatedTransactionDailyReconciliationFile",
+        "monthlyReconciliationFile",
+    ],
+    typing.Any,
+]

kard/files/types/files_metadata_sort_options.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+FilesMetadataSortOptions = typing.Union[typing.Literal["sentDate", "-sentDate"], typing.Any]

kard/files/types/get_files_metadata_response.py

@@ -0,0 +1,71 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...commons.types.links import Links
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .file_metadata_with_url import FileMetadataWithUrl
+from .pagination_meta import PaginationMeta
+
+
+class GetFilesMetadataResponse(UniversalBaseModel):
+    """
+    Examples
+    --------
+    from kard.commons import Links
+    from kard.files import (
+        FileMetadataAttribute,
+        FileMetadataWithUrl,
+        GetFilesMetadataResponse,
+        PaginationMeta,
+    )
+
+    GetFilesMetadataResponse(
+        data=[
+            FileMetadataWithUrl(
+                type="earnedRewardApprovedDailyReconciliationFile",
+                attributes=FileMetadataAttribute(
+                    file_name="test-file-10.jsonl",
+                    sent_at="2025-03-09T21:56:23Z",
+                    last_modified="2025-03-19T21:56:23Z",
+                    download_url="https://default-bucket.s3.us-east-1.amazonaws.com/test-file-10.jsonl?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Checksum-Mode=ENABLED&X-Amz-Credential=test%2F20250320%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250320T172109Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=c2a7dc6d14d0465b9ba9c24d47574a6bbcfa57856529319f25424c6bb1cf5204",
+                ),
+                id="67db3d87cb70469be876c852049",
+            )
+        ],
+        links=Links(
+            self_="/v2/files/issuers/0004321/metadata?page%5Bafter%5D=MjAyNS0wMy0xMFQyMTo1NjoyMy40OTY4ODda&page%5Bsize%5D=5&sort%5Bsent_at%5D=DESC",
+            prev="/v2/files/issuers/0004321/metadata?page%5Bbefore%5D=MjAyNS0wMy0wOVQyMTo1NjoyMy40OTY4ODda&page%5Bsize%5D=5&sort%5Bsent_at%5D=DESC",
+            next="/v2/files/issuers/0004321/metadata?page%5Bafter%5D=MjAyNS0wMy0wNVQyMTo1NjoyMy40OTY4ODda&page%5Bsize%5D=5&sort%5Bsent_at%5D=DESC",
+        ),
+        meta=PaginationMeta(
+            page_size=5,
+            has_next_page=True,
+        ),
+    )
+    """
+
+    data: typing.List[FileMetadataWithUrl] = pydantic.Field()
+    """
+    List of file metadata objects with their pre-signed URLs.
+    """
+
+    links: Links = pydantic.Field()
+    """
+    Navigation links for paginated results.
+    """
+
+    meta: PaginationMeta = pydantic.Field()
+    """
+    Metadata about the pagination status.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

kard/files/types/pagination_meta.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...core.serialization import FieldMetadata
+
+
+class PaginationMeta(UniversalBaseModel):
+    page_size: typing_extensions.Annotated[int, FieldMetadata(alias="pageSize")] = pydantic.Field()
+    """
+    Number of items per page.
+    """
+
+    has_next_page: typing_extensions.Annotated[bool, FieldMetadata(alias="hasNextPage")] = pydantic.Field()
+    """
+    Indicates if there are more pages available after the current one.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow