moovio_sdk 0.11.5__py3-none-any.whl → 0.12.0__py3-none-any.whl

moovio_sdk/models/operations/listtransfers.py

@@ -70,6 +70,8 @@ class ListTransfersRequestTypedDict(TypedDict):
     r"""Optional parameter to only return refunded transfers."""
     disputed: NotRequired[bool]
     r"""Optional parameter to only return disputed transfers."""
+    foreign_id: NotRequired[str]
+    r"""Optional alias from a foreign/external system which can be used to reference this resource."""
     skip: NotRequired[int]
     count: NotRequired[int]
 
@@ -141,6 +143,13 @@ class ListTransfersRequest(BaseModel):
     ] = None
     r"""Optional parameter to only return disputed transfers."""
 
+    foreign_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="foreignID"),
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),
+    ] = None
+    r"""Optional alias from a foreign/external system which can be used to reference this resource."""
+
     skip: Annotated[
         Optional[int],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=False)),

moovio_sdk/models/operations/saveunderwriting.py

@@ -0,0 +1,78 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from moovio_sdk.models.components import (
+    underwriting as components_underwriting,
+    upsertunderwriting as components_upsertunderwriting,
+)
+from moovio_sdk.types import BaseModel
+from moovio_sdk.utils import (
+    FieldMetadata,
+    HeaderMetadata,
+    PathParamMetadata,
+    RequestMetadata,
+)
+import pydantic
+from typing import Dict, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class SaveUnderwritingGlobalsTypedDict(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 SaveUnderwritingGlobals(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 SaveUnderwritingRequestTypedDict(TypedDict):
+    account_id: str
+    upsert_underwriting: components_upsertunderwriting.UpsertUnderwritingTypedDict
+
+
+class SaveUnderwritingRequest(BaseModel):
+    account_id: Annotated[
+        str,
+        pydantic.Field(alias="accountID"),
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+
+    upsert_underwriting: Annotated[
+        components_upsertunderwriting.UpsertUnderwriting,
+        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+    ]
+
+
+class SaveUnderwritingResponseTypedDict(TypedDict):
+    headers: Dict[str, List[str]]
+    result: components_underwriting.UnderwritingTypedDict
+
+
+class SaveUnderwritingResponse(BaseModel):
+    headers: Dict[str, List[str]]
+
+    result: components_underwriting.Underwriting

moovio_sdk/transfers.py

@@ -359,6 +359,7 @@ class Transfers(BaseSDK):
         sales_tax_amount: Optional[
             Union[components.Amount, components.AmountTypedDict]
         ] = None,
+        foreign_id: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -381,6 +382,7 @@ class Transfers(BaseSDK):
         :param description: An optional description of the transfer that is used on receipts and for your own internal use.
         :param metadata: Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
         :param sales_tax_amount: Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.
+        :param foreign_id: Optional alias from a foreign/external system which can be used to reference this resource.
         :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
@@ -416,6 +418,7 @@ class Transfers(BaseSDK):
                 sales_tax_amount=utils.get_pydantic_model(
                     sales_tax_amount, Optional[components.Amount]
                 ),
+                foreign_id=foreign_id,
             ),
         )
 
@@ -553,6 +556,7 @@ class Transfers(BaseSDK):
         sales_tax_amount: Optional[
             Union[components.Amount, components.AmountTypedDict]
         ] = None,
+        foreign_id: Optional[str] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -575,6 +579,7 @@ class Transfers(BaseSDK):
         :param description: An optional description of the transfer that is used on receipts and for your own internal use.
         :param metadata: Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
         :param sales_tax_amount: Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged.
+        :param foreign_id: Optional alias from a foreign/external system which can be used to reference this resource.
         :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
@@ -610,6 +615,7 @@ class Transfers(BaseSDK):
                 sales_tax_amount=utils.get_pydantic_model(
                     sales_tax_amount, Optional[components.Amount]
                 ),
+                foreign_id=foreign_id,
             ),
         )
 
@@ -738,6 +744,7 @@ class Transfers(BaseSDK):
         payment_link_code: Optional[str] = None,
         refunded: Optional[bool] = None,
         disputed: Optional[bool] = None,
+        foreign_id: Optional[str] = None,
         skip: Optional[int] = None,
         count: Optional[int] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -767,6 +774,7 @@ class Transfers(BaseSDK):
         :param payment_link_code: Optional code to filter for transfers associated with the payment link.
         :param refunded: Optional parameter to only return refunded transfers.
         :param disputed: Optional parameter to only return disputed transfers.
+        :param foreign_id: Optional alias from a foreign/external system which can be used to reference this resource.
         :param skip:
         :param count:
         :param retries: Override the default retry configuration for this method
@@ -794,6 +802,7 @@ class Transfers(BaseSDK):
             payment_link_code=payment_link_code,
             refunded=refunded,
             disputed=disputed,
+            foreign_id=foreign_id,
             skip=skip,
             count=count,
             account_id=account_id,
@@ -889,6 +898,7 @@ class Transfers(BaseSDK):
         payment_link_code: Optional[str] = None,
         refunded: Optional[bool] = None,
         disputed: Optional[bool] = None,
+        foreign_id: Optional[str] = None,
         skip: Optional[int] = None,
         count: Optional[int] = None,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -918,6 +928,7 @@ class Transfers(BaseSDK):
         :param payment_link_code: Optional code to filter for transfers associated with the payment link.
         :param refunded: Optional parameter to only return refunded transfers.
         :param disputed: Optional parameter to only return disputed transfers.
+        :param foreign_id: Optional alias from a foreign/external system which can be used to reference this resource.
         :param skip:
         :param count:
         :param retries: Override the default retry configuration for this method
@@ -945,6 +956,7 @@ class Transfers(BaseSDK):
             payment_link_code=payment_link_code,
             refunded=refunded,
             disputed=disputed,
+            foreign_id=foreign_id,
             skip=skip,
             count=count,
             account_id=account_id,

moovio_sdk/underwriting.py

@@ -236,6 +236,374 @@ class Underwriting(BaseSDK):
             http_res,
         )
 
+    def save(
+        self,
+        *,
+        account_id: str,
+        geographic_reach: Optional[components.GeographicReach] = None,
+        business_presence: Optional[components.BusinessPresence] = None,
+        pending_litigation: Optional[components.PendingLitigation] = None,
+        volume_share_by_customer_type: Optional[
+            Union[
+                components.VolumeShareByCustomerType,
+                components.VolumeShareByCustomerTypeTypedDict,
+            ]
+        ] = None,
+        collect_funds: Optional[
+            Union[components.CollectFunds, components.CollectFundsTypedDict]
+        ] = None,
+        money_transfer: Optional[
+            Union[components.MoneyTransfer, components.MoneyTransferTypedDict]
+        ] = None,
+        send_funds: Optional[
+            Union[components.SendFunds, components.SendFundsTypedDict]
+        ] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> operations.SaveUnderwritingResponse:
+        r"""Create or update the account's underwriting.
+
+        Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.
+
+        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.write` scope.
+
+        :param account_id:
+        :param geographic_reach:
+        :param business_presence:
+        :param pending_litigation:
+        :param volume_share_by_customer_type:
+        :param collect_funds:
+        :param money_transfer:
+        :param send_funds:
+        :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.SaveUnderwritingRequest(
+            account_id=account_id,
+            upsert_underwriting=components.UpsertUnderwriting(
+                geographic_reach=geographic_reach,
+                business_presence=business_presence,
+                pending_litigation=pending_litigation,
+                volume_share_by_customer_type=utils.get_pydantic_model(
+                    volume_share_by_customer_type,
+                    Optional[components.VolumeShareByCustomerType],
+                ),
+                collect_funds=utils.get_pydantic_model(
+                    collect_funds, Optional[components.CollectFunds]
+                ),
+                money_transfer=utils.get_pydantic_model(
+                    money_transfer, Optional[components.MoneyTransfer]
+                ),
+                send_funds=utils.get_pydantic_model(
+                    send_funds, Optional[components.SendFunds]
+                ),
+            ),
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/accounts/{accountID}/underwriting",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            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.SaveUnderwritingGlobals(
+                x_moov_version=self.sdk_configuration.globals.x_moov_version,
+            ),
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.upsert_underwriting,
+                False,
+                False,
+                "json",
+                components.UpsertUnderwriting,
+            ),
+            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="saveUnderwriting",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, components.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=[
+                "400",
+                "401",
+                "403",
+                "404",
+                "409",
+                "422",
+                "429",
+                "4XX",
+                "500",
+                "504",
+                "5XX",
+            ],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return operations.SaveUnderwritingResponse(
+                result=utils.unmarshal_json(http_res.text, components.Underwriting),
+                headers=utils.get_response_headers(http_res.headers),
+            )
+        if utils.match_response(http_res, ["400", "409"], "application/json"):
+            response_data = utils.unmarshal_json(http_res.text, errors.GenericErrorData)
+            raise errors.GenericError(data=response_data)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = utils.unmarshal_json(
+                http_res.text, errors.UpsertUnderwritingErrorData
+            )
+            raise errors.UpsertUnderwritingError(data=response_data)
+        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.status_code, http_res_text, http_res
+            )
+        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.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError(
+                "API error occurred", http_res.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = utils.stream_to_text(http_res)
+        raise errors.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )
+
+    async def save_async(
+        self,
+        *,
+        account_id: str,
+        geographic_reach: Optional[components.GeographicReach] = None,
+        business_presence: Optional[components.BusinessPresence] = None,
+        pending_litigation: Optional[components.PendingLitigation] = None,
+        volume_share_by_customer_type: Optional[
+            Union[
+                components.VolumeShareByCustomerType,
+                components.VolumeShareByCustomerTypeTypedDict,
+            ]
+        ] = None,
+        collect_funds: Optional[
+            Union[components.CollectFunds, components.CollectFundsTypedDict]
+        ] = None,
+        money_transfer: Optional[
+            Union[components.MoneyTransfer, components.MoneyTransferTypedDict]
+        ] = None,
+        send_funds: Optional[
+            Union[components.SendFunds, components.SendFundsTypedDict]
+        ] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> operations.SaveUnderwritingResponse:
+        r"""Create or update the account's underwriting.
+
+        Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.
+
+        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.write` scope.
+
+        :param account_id:
+        :param geographic_reach:
+        :param business_presence:
+        :param pending_litigation:
+        :param volume_share_by_customer_type:
+        :param collect_funds:
+        :param money_transfer:
+        :param send_funds:
+        :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.SaveUnderwritingRequest(
+            account_id=account_id,
+            upsert_underwriting=components.UpsertUnderwriting(
+                geographic_reach=geographic_reach,
+                business_presence=business_presence,
+                pending_litigation=pending_litigation,
+                volume_share_by_customer_type=utils.get_pydantic_model(
+                    volume_share_by_customer_type,
+                    Optional[components.VolumeShareByCustomerType],
+                ),
+                collect_funds=utils.get_pydantic_model(
+                    collect_funds, Optional[components.CollectFunds]
+                ),
+                money_transfer=utils.get_pydantic_model(
+                    money_transfer, Optional[components.MoneyTransfer]
+                ),
+                send_funds=utils.get_pydantic_model(
+                    send_funds, Optional[components.SendFunds]
+                ),
+            ),
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/accounts/{accountID}/underwriting",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=True,
+            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.SaveUnderwritingGlobals(
+                x_moov_version=self.sdk_configuration.globals.x_moov_version,
+            ),
+            security=self.sdk_configuration.security,
+            get_serialized_body=lambda: utils.serialize_request_body(
+                request.upsert_underwriting,
+                False,
+                False,
+                "json",
+                components.UpsertUnderwriting,
+            ),
+            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="saveUnderwriting",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, components.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=[
+                "400",
+                "401",
+                "403",
+                "404",
+                "409",
+                "422",
+                "429",
+                "4XX",
+                "500",
+                "504",
+                "5XX",
+            ],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return operations.SaveUnderwritingResponse(
+                result=utils.unmarshal_json(http_res.text, components.Underwriting),
+                headers=utils.get_response_headers(http_res.headers),
+            )
+        if utils.match_response(http_res, ["400", "409"], "application/json"):
+            response_data = utils.unmarshal_json(http_res.text, errors.GenericErrorData)
+            raise errors.GenericError(data=response_data)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = utils.unmarshal_json(
+                http_res.text, errors.UpsertUnderwritingErrorData
+            )
+            raise errors.UpsertUnderwritingError(data=response_data)
+        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.status_code, http_res_text, http_res
+            )
+        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.status_code, http_res_text, http_res
+            )
+        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.status_code, http_res_text, http_res
+            )
+        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.status_code, http_res_text, http_res
+            )
+
+        content_type = http_res.headers.get("Content-Type")
+        http_res_text = await utils.stream_to_text_async(http_res)
+        raise errors.APIError(
+            f"Unexpected response received (code: {http_res.status_code}, type: {content_type})",
+            http_res.status_code,
+            http_res_text,
+            http_res,
+        )
+
     def upsert(
         self,
         *,

{moovio_sdk-0.11.5.dist-info → moovio_sdk-0.12.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: moovio_sdk
-Version: 0.11.5
+Version: 0.12.0
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Speakeasy
 Requires-Python: >=3.9.2
@@ -1139,6 +1139,12 @@ Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/
 
 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.
+* [save](https://github.com/moovfinancial/moov-python/blob/master/docs/sdks/underwriting/README.md#save) - Create or update the account's underwriting.
+
+Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.
+
+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.write` scope.
 * [upsert](https://github.com/moovfinancial/moov-python/blob/master/docs/sdks/underwriting/README.md#upsert) - Create or update the account's underwriting.
 
 Read our [underwriting guide](https://docs.moov.io/guides/accounts/requirements/underwriting/) to learn more.