moovio_sdk 0.14.7__py3-none-any.whl → 0.15.0__py3-none-any.whl

moovio_sdk/models/operations/liststatements.py

@@ -0,0 +1,100 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from datetime import datetime
+from moovio_sdk.models.components import statement as components_statement
+from moovio_sdk.types import BaseModel
+from moovio_sdk.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    QueryParamMetadata,
+)
+import pydantic
+from typing import Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class ListStatementsGlobalsTypedDict(TypedDict):
+    x_moov_version: NotRequired[str]
+    r"""Specify an API version.
+
+    API versioning follows the format `vYYYY.QQ.BB`, where
+    - `YYYY` is the year
+    - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+    - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
+    - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+
+    The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+    """
+
+
+class ListStatementsGlobals(BaseModel):
+    x_moov_version: Annotated[
+        Optional[str],
+        pydantic.Field(alias="x-moov-version"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ] = "v2024.01.00"
+    r"""Specify an API version.
+
+    API versioning follows the format `vYYYY.QQ.BB`, where
+    - `YYYY` is the year
+    - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+    - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
+    - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+
+    The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+    """
+
+
+class ListStatementsRequestTypedDict(TypedDict):
+    account_id: str
+    billing_period_start_date_time: NotRequired[datetime]
+    r"""Optional date-time which inclusively filters all statements where billing period is on or after this date-time."""
+    billing_period_end_date_time: NotRequired[datetime]
+    r"""Optional date-time which exclusively filters all statements where billing period is before this date-time."""
+    skip: NotRequired[int]
+    count: NotRequired[int]
+
+
+class ListStatementsRequest(BaseModel):
+    account_id: Annotated[
+        str,
+        pydantic.Field(alias="accountID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+
+    billing_period_start_date_time: Annotated[
+        Optional[datetime],
+        pydantic.Field(alias="billingPeriodStartDateTime"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),
+    ] = None
+    r"""Optional date-time which inclusively filters all statements where billing period is on or after this date-time."""
+
+    billing_period_end_date_time: Annotated[
+        Optional[datetime],
+        pydantic.Field(alias="billingPeriodEndDateTime"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),
+    ] = None
+    r"""Optional date-time which exclusively filters all statements where billing period is before this date-time."""
+
+    skip: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),
+    ] = None
+
+    count: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),
+    ] = None
+
+
+class ListStatementsResponseTypedDict(TypedDict):
+    headers: Dict[str, List[str]]
+    result: List[components_statement.StatementTypedDict]
+
+
+class ListStatementsResponse(BaseModel):
+    headers: Dict[str, List[str]]
+
+    result: List[components_statement.Statement]

moovio_sdk/sdk.py

@@ -43,6 +43,7 @@ if TYPE_CHECKING:
     from moovio_sdk.receipts import Receipts
     from moovio_sdk.representatives import Representatives
     from moovio_sdk.scheduling import Scheduling
+    from moovio_sdk.statements import Statements
     from moovio_sdk.support import Support
     from moovio_sdk.sweeps import Sweeps
     from moovio_sdk.terminal_applications import TerminalApplications
@@ -73,6 +74,7 @@ class Moov(BaseSDK):
     payment_methods: "PaymentMethods"
     representatives: "Representatives"
     scheduling: "Scheduling"
+    statements: "Statements"
     sweeps: "Sweeps"
     account_terminal_applications: "AccountTerminalApplications"
     support: "Support"
@@ -108,6 +110,7 @@ class Moov(BaseSDK):
         "payment_methods": ("moovio_sdk.payment_methods", "PaymentMethods"),
         "representatives": ("moovio_sdk.representatives", "Representatives"),
         "scheduling": ("moovio_sdk.scheduling", "Scheduling"),
+        "statements": ("moovio_sdk.statements", "Statements"),
         "sweeps": ("moovio_sdk.sweeps", "Sweeps"),
         "account_terminal_applications": (
             "moovio_sdk.account_terminal_applications",

moovio_sdk/statements.py

@@ -0,0 +1,471 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from .basesdk import BaseSDK
+from datetime import datetime
+from enum import Enum
+from moovio_sdk import utils
+from moovio_sdk._hooks import HookContext
+from moovio_sdk.models import components, errors, operations
+from moovio_sdk.types import OptionalNullable, UNSET
+from moovio_sdk.utils import get_security_from_env
+from moovio_sdk.utils.unmarshal_json_response import unmarshal_json_response
+from typing import Any, List, Mapping, Optional
+
+
+class GetAcceptEnum(str, Enum):
+    APPLICATION_JSON = "application/json"
+    APPLICATION_PDF = "application/pdf"
+
+
+class Statements(BaseSDK):
+    def list(
+        self,
+        *,
+        account_id: str,
+        billing_period_start_date_time: Optional[datetime] = None,
+        billing_period_end_date_time: Optional[datetime] = None,
+        skip: Optional[int] = None,
+        count: Optional[int] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> operations.ListStatementsResponse:
+        r"""Retrieve all statements associated with an account.
+
+        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+        you'll need to specify the `/accounts/{accountID}/profile.read` scope.
+
+        :param account_id:
+        :param billing_period_start_date_time: Optional date-time which inclusively filters all statements where billing period is on or after this date-time.
+        :param billing_period_end_date_time: Optional date-time which exclusively filters all statements where billing period is before this date-time.
+        :param skip:
+        :param count:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = operations.ListStatementsRequest(
+            billing_period_start_date_time=billing_period_start_date_time,
+            billing_period_end_date_time=billing_period_end_date_time,
+            skip=skip,
+            count=count,
+            account_id=account_id,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/accounts/{accountID}/statements",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            _globals=operations.ListStatementsGlobals(
+                x_moov_version=self.sdk_configuration.globals.x_moov_version,
+            ),
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="listStatements",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, components.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "429", "4XX", "500", "504", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return operations.ListStatementsResponse(
+                result=unmarshal_json_response(List[components.Statement], http_res),
+                headers=utils.get_response_headers(http_res.headers),
+            )
+        if utils.match_response(http_res, "400", "application/json"):
+            response_data = unmarshal_json_response(errors.GenericErrorData, http_res)
+            raise errors.GenericError(response_data, http_res)
+        if utils.match_response(http_res, ["401", "403", "429"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, ["500", "504"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def list_async(
+        self,
+        *,
+        account_id: str,
+        billing_period_start_date_time: Optional[datetime] = None,
+        billing_period_end_date_time: Optional[datetime] = None,
+        skip: Optional[int] = None,
+        count: Optional[int] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> operations.ListStatementsResponse:
+        r"""Retrieve all statements associated with an account.
+
+        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+        you'll need to specify the `/accounts/{accountID}/profile.read` scope.
+
+        :param account_id:
+        :param billing_period_start_date_time: Optional date-time which inclusively filters all statements where billing period is on or after this date-time.
+        :param billing_period_end_date_time: Optional date-time which exclusively filters all statements where billing period is before this date-time.
+        :param skip:
+        :param count:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = operations.ListStatementsRequest(
+            billing_period_start_date_time=billing_period_start_date_time,
+            billing_period_end_date_time=billing_period_end_date_time,
+            skip=skip,
+            count=count,
+            account_id=account_id,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/accounts/{accountID}/statements",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            _globals=operations.ListStatementsGlobals(
+                x_moov_version=self.sdk_configuration.globals.x_moov_version,
+            ),
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="listStatements",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, components.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["400", "401", "403", "429", "4XX", "500", "504", "5XX"],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return operations.ListStatementsResponse(
+                result=unmarshal_json_response(List[components.Statement], http_res),
+                headers=utils.get_response_headers(http_res.headers),
+            )
+        if utils.match_response(http_res, "400", "application/json"):
+            response_data = unmarshal_json_response(errors.GenericErrorData, http_res)
+            raise errors.GenericError(response_data, http_res)
+        if utils.match_response(http_res, ["401", "403", "429"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, ["500", "504"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    def get(
+        self,
+        *,
+        account_id: str,
+        statement_id: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        accept_header_override: Optional[GetAcceptEnum] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> operations.GetStatementResponse:
+        r"""Retrieve a statement by its ID.
+
+        Use the `Accept` header to specify the format of the response. Supported formats are `application/json` and `application/pdf`.
+
+        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+        you'll need to specify the `/accounts/{accountID}/profile.read` scope.
+
+        :param account_id:
+        :param statement_id:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param accept_header_override: Override the default accept header for this method
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = operations.GetStatementRequest(
+            account_id=account_id,
+            statement_id=statement_id,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/accounts/{accountID}/statements/{statementID}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value=accept_header_override.value
+            if accept_header_override is not None
+            else "application/json;q=1, application/pdf;q=0",
+            http_headers=http_headers,
+            _globals=operations.GetStatementGlobals(
+                x_moov_version=self.sdk_configuration.globals.x_moov_version,
+            ),
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="getStatement",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, components.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["401", "403", "404", "429", "4XX", "500", "504", "5XX"],
+            stream=True,
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            http_res_text = utils.stream_to_text(http_res)
+            return operations.GetStatementResponse(
+                result=unmarshal_json_response(
+                    components.Statement, http_res, http_res_text
+                ),
+                headers=utils.get_response_headers(http_res.headers),
+            )
+        if utils.match_response(http_res, "200", "application/pdf"):
+            return operations.GetStatementResponse(
+                result=http_res, headers=utils.get_response_headers(http_res.headers)
+            )
+        if utils.match_response(http_res, ["401", "403", "404", "429"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, ["500", "504"], "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        http_res_text = utils.stream_to_text(http_res)
+        raise errors.APIError("Unexpected response received", http_res, http_res_text)
+
+    async def get_async(
+        self,
+        *,
+        account_id: str,
+        statement_id: str,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        accept_header_override: Optional[GetAcceptEnum] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> operations.GetStatementResponse:
+        r"""Retrieve a statement by its ID.
+
+        Use the `Accept` header to specify the format of the response. Supported formats are `application/json` and `application/pdf`.
+
+        To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+        you'll need to specify the `/accounts/{accountID}/profile.read` scope.
+
+        :param account_id:
+        :param statement_id:
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param accept_header_override: Override the default accept header for this method
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = operations.GetStatementRequest(
+            account_id=account_id,
+            statement_id=statement_id,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/accounts/{accountID}/statements/{statementID}",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=True,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value=accept_header_override.value
+            if accept_header_override is not None
+            else "application/json;q=1, application/pdf;q=0",
+            http_headers=http_headers,
+            _globals=operations.GetStatementGlobals(
+                x_moov_version=self.sdk_configuration.globals.x_moov_version,
+            ),
+            security=self.sdk_configuration.security,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="getStatement",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, components.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=["401", "403", "404", "429", "4XX", "500", "504", "5XX"],
+            stream=True,
+            retry_config=retry_config,
+        )
+
+        if utils.match_response(http_res, "200", "application/json"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            return operations.GetStatementResponse(
+                result=unmarshal_json_response(
+                    components.Statement, http_res, http_res_text
+                ),
+                headers=utils.get_response_headers(http_res.headers),
+            )
+        if utils.match_response(http_res, "200", "application/pdf"):
+            return operations.GetStatementResponse(
+                result=http_res, headers=utils.get_response_headers(http_res.headers)
+            )
+        if utils.match_response(http_res, ["401", "403", "404", "429"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, ["500", "504"], "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        http_res_text = await utils.stream_to_text_async(http_res)
+        raise errors.APIError("Unexpected response received", http_res, http_res_text)