gr4vy 1.2.0__tar.gz → 1.2.1__tar.gz

{gr4vy-1.2.0 → gr4vy-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gr4vy
-Version: 1.2.0
+Version: 1.2.1
 Summary: Python Client SDK Generated by Speakeasy.
 Author: Gr4vy
 Requires-Python: >=3.9.2
@@ -490,6 +490,7 @@ except ValueError as error:
 * [update](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/transactions/README.md#update) - Manually update a transaction
 * [capture](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/transactions/README.md#capture) - Capture transaction
 * [void](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/transactions/README.md#void) - Void transaction
+* [cancel](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/transactions/README.md#cancel) - Cancel transaction
 * [sync](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/transactions/README.md#sync) - Sync transaction
 
 #### [transactions.events](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/events/README.md)

{gr4vy-1.2.0 → gr4vy-1.2.1}/README-PYPI.md

@@ -469,6 +469,7 @@ except ValueError as error:
 * [update](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/transactions/README.md#update) - Manually update a transaction
 * [capture](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/transactions/README.md#capture) - Capture transaction
 * [void](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/transactions/README.md#void) - Void transaction
+* [cancel](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/transactions/README.md#cancel) - Cancel transaction
 * [sync](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/transactions/README.md#sync) - Sync transaction
 
 #### [transactions.events](https://github.com/gr4vy/gr4vy-python/blob/master/docs/sdks/events/README.md)

{gr4vy-1.2.0 → gr4vy-1.2.1}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "gr4vy"
-version = "1.2.0"
+version = "1.2.1"
 description = "Python Client SDK Generated by Speakeasy."
 authors = [{ name = "Gr4vy" },]
 readme = "README-PYPI.md"

{gr4vy-1.2.0 → gr4vy-1.2.1}/src/gr4vy/_version.py

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "gr4vy"
-__version__: str = "1.2.0"
+__version__: str = "1.2.1"
 __openapi_doc_version__: str = "1.0.0"
 __gen_version__: str = "2.687.13"
-__user_agent__: str = "speakeasy-sdk/python 1.2.0 2.687.13 1.0.0 gr4vy"
+__user_agent__: str = "speakeasy-sdk/python 1.2.1 2.687.13 1.0.0 gr4vy"
 
 try:
     if __package__ is not None:

{gr4vy-1.2.0 → gr4vy-1.2.1}/src/gr4vy/models/__init__.py

@@ -97,6 +97,13 @@ if TYPE_CHECKING:
     from .buyercreate import BuyerCreate, BuyerCreateTypedDict
     from .buyers import Buyers, BuyersTypedDict
     from .buyerupdate import BuyerUpdate, BuyerUpdateTypedDict
+    from .cancel_transactionop import (
+        CancelTransactionGlobals,
+        CancelTransactionGlobalsTypedDict,
+        CancelTransactionRequest,
+        CancelTransactionRequestTypedDict,
+    )
+    from .cancelstatus import CancelStatus
     from .capture_transactionop import (
         CaptureTransactionGlobals,
         CaptureTransactionGlobalsTypedDict,
@@ -977,6 +984,7 @@ if TYPE_CHECKING:
     )
     from .transaction import Transaction, TransactionTypedDict
     from .transactionbuyer import TransactionBuyer, TransactionBuyerTypedDict
+    from .transactioncancel import TransactionCancel, TransactionCancelTypedDict
     from .transactioncapture import TransactionCapture, TransactionCaptureTypedDict
     from .transactioncapturecreate import (
         TransactionCaptureCreate,
@@ -1224,6 +1232,11 @@ __all__ = [
     "Buyers",
     "BuyersTypedDict",
     "CVVResponseCode",
+    "CancelStatus",
+    "CancelTransactionGlobals",
+    "CancelTransactionGlobalsTypedDict",
+    "CancelTransactionRequest",
+    "CancelTransactionRequestTypedDict",
     "CaptureStatus",
     "CaptureTransactionGlobals",
     "CaptureTransactionGlobalsTypedDict",
@@ -1907,6 +1920,8 @@ __all__ = [
     "Transaction",
     "TransactionBuyer",
     "TransactionBuyerTypedDict",
+    "TransactionCancel",
+    "TransactionCancelTypedDict",
     "TransactionCapture",
     "TransactionCaptureCreate",
     "TransactionCaptureCreateTypedDict",
@@ -2109,6 +2124,11 @@ _dynamic_imports: dict[str, str] = {
     "BuyersTypedDict": ".buyers",
     "BuyerUpdate": ".buyerupdate",
     "BuyerUpdateTypedDict": ".buyerupdate",
+    "CancelTransactionGlobals": ".cancel_transactionop",
+    "CancelTransactionGlobalsTypedDict": ".cancel_transactionop",
+    "CancelTransactionRequest": ".cancel_transactionop",
+    "CancelTransactionRequestTypedDict": ".cancel_transactionop",
+    "CancelStatus": ".cancelstatus",
     "CaptureTransactionGlobals": ".capture_transactionop",
     "CaptureTransactionGlobalsTypedDict": ".capture_transactionop",
     "CaptureTransactionRequest": ".capture_transactionop",
@@ -2784,6 +2804,8 @@ _dynamic_imports: dict[str, str] = {
     "TransactionTypedDict": ".transaction",
     "TransactionBuyer": ".transactionbuyer",
     "TransactionBuyerTypedDict": ".transactionbuyer",
+    "TransactionCancel": ".transactioncancel",
+    "TransactionCancelTypedDict": ".transactioncancel",
     "TransactionCapture": ".transactioncapture",
     "TransactionCaptureTypedDict": ".transactioncapture",
     "TransactionCaptureCreate": ".transactioncapturecreate",

gr4vy-1.2.1/src/gr4vy/models/cancel_transactionop.py

@@ -0,0 +1,43 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from gr4vy.types import BaseModel
+from gr4vy.utils import FieldMetadata, HeaderMetadata, PathParamMetadata
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CancelTransactionGlobalsTypedDict(TypedDict):
+    merchant_account_id: NotRequired[str]
+    r"""The ID of the merchant account to use for this request."""
+
+
+class CancelTransactionGlobals(BaseModel):
+    merchant_account_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="x-gr4vy-merchant-account-id"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ] = None
+    r"""The ID of the merchant account to use for this request."""
+
+
+class CancelTransactionRequestTypedDict(TypedDict):
+    transaction_id: str
+    r"""The ID of the transaction"""
+    merchant_account_id: NotRequired[str]
+    r"""The ID of the merchant account to use for this request."""
+
+
+class CancelTransactionRequest(BaseModel):
+    transaction_id: Annotated[
+        str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+    r"""The ID of the transaction"""
+
+    merchant_account_id: Annotated[
+        Optional[str],
+        pydantic.Field(alias="x-gr4vy-merchant-account-id"),
+        FieldMetadata(header=HeaderMetadata(style="simple", explode=False)),
+    ] = None
+    r"""The ID of the merchant account to use for this request."""

gr4vy-1.2.1/src/gr4vy/models/cancelstatus.py

@@ -0,0 +1,8 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from gr4vy.types import UnrecognizedStr
+from typing import Literal, Union
+
+
+CancelStatus = Union[Literal["succeeded", "pending", "failed"], UnrecognizedStr]

gr4vy-1.2.1/src/gr4vy/models/transactioncancel.py

@@ -0,0 +1,81 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .cancelstatus import CancelStatus
+from .transaction import Transaction, TransactionTypedDict
+from gr4vy.types import BaseModel, Nullable, UNSET_SENTINEL
+from gr4vy.utils import validate_const, validate_open_enum
+import pydantic
+from pydantic import model_serializer
+from pydantic.functional_validators import AfterValidator, PlainValidator
+from typing import Literal, Optional
+from typing_extensions import Annotated, TypedDict
+
+
+class TransactionCancelTypedDict(TypedDict):
+    status: CancelStatus
+    code: Nullable[str]
+    r"""The standardized error code set by Gr4vy."""
+    raw_response_code: Nullable[str]
+    r"""This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services."""
+    raw_response_description: Nullable[str]
+    r"""This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services."""
+    transaction: TransactionTypedDict
+    r"""A full transaction resource."""
+    type: Literal["transaction-cancel"]
+    r"""Always `transaction-cancel`."""
+
+
+class TransactionCancel(BaseModel):
+    status: Annotated[CancelStatus, PlainValidator(validate_open_enum(False))]
+
+    code: Nullable[str]
+    r"""The standardized error code set by Gr4vy."""
+
+    raw_response_code: Nullable[str]
+    r"""This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services."""
+
+    raw_response_description: Nullable[str]
+    r"""This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services."""
+
+    transaction: Transaction
+    r"""A full transaction resource."""
+
+    TYPE: Annotated[
+        Annotated[
+            Optional[Literal["transaction-cancel"]],
+            AfterValidator(validate_const("transaction-cancel")),
+        ],
+        pydantic.Field(alias="type"),
+    ] = "transaction-cancel"
+    r"""Always `transaction-cancel`."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["type"]
+        nullable_fields = ["code", "raw_response_code", "raw_response_description"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

{gr4vy-1.2.0 → gr4vy-1.2.1}/src/gr4vy/transactions.py

@@ -2546,6 +2546,292 @@ class Transactions(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
+    def cancel(
+        self,
+        *,
+        transaction_id: str,
+        merchant_account_id: Optional[str] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.TransactionCancel:
+        r"""Cancel transaction
+
+        Cancels a pending transaction. If the transaction was successfully authorized, or was already captured, the cancel will not be processed.
+
+        :param transaction_id: The ID of the transaction
+        :param merchant_account_id: The ID of the merchant account to use for this request.
+        :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 = models.CancelTransactionRequest(
+            transaction_id=transaction_id,
+            merchant_account_id=merchant_account_id,
+        )
+
+        req = self._build_request(
+            method="POST",
+            path="/transactions/{transaction_id}/cancel",
+            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=models.CancelTransactionGlobals(
+                merchant_account_id=self.sdk_configuration.globals.merchant_account_id,
+            ),
+            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="cancel_transaction",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=[
+                "400",
+                "401",
+                "403",
+                "404",
+                "405",
+                "409",
+                "422",
+                "425",
+                "429",
+                "4XX",
+                "500",
+                "502",
+                "504",
+                "5XX",
+            ],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.TransactionCancel, http_res)
+        if utils.match_response(http_res, "400", "application/json"):
+            response_data = unmarshal_json_response(errors.Error400Data, http_res)
+            raise errors.Error400(response_data, http_res)
+        if utils.match_response(http_res, "401", "application/json"):
+            response_data = unmarshal_json_response(errors.Error401Data, http_res)
+            raise errors.Error401(response_data, http_res)
+        if utils.match_response(http_res, "403", "application/json"):
+            response_data = unmarshal_json_response(errors.Error403Data, http_res)
+            raise errors.Error403(response_data, http_res)
+        if utils.match_response(http_res, "404", "application/json"):
+            response_data = unmarshal_json_response(errors.Error404Data, http_res)
+            raise errors.Error404(response_data, http_res)
+        if utils.match_response(http_res, "405", "application/json"):
+            response_data = unmarshal_json_response(errors.Error405Data, http_res)
+            raise errors.Error405(response_data, http_res)
+        if utils.match_response(http_res, "409", "application/json"):
+            response_data = unmarshal_json_response(errors.Error409Data, http_res)
+            raise errors.Error409(response_data, http_res)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.HTTPValidationErrorData, http_res
+            )
+            raise errors.HTTPValidationError(response_data, http_res)
+        if utils.match_response(http_res, "425", "application/json"):
+            response_data = unmarshal_json_response(errors.Error425Data, http_res)
+            raise errors.Error425(response_data, http_res)
+        if utils.match_response(http_res, "429", "application/json"):
+            response_data = unmarshal_json_response(errors.Error429Data, http_res)
+            raise errors.Error429(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.Error500Data, http_res)
+            raise errors.Error500(response_data, http_res)
+        if utils.match_response(http_res, "502", "application/json"):
+            response_data = unmarshal_json_response(errors.Error502Data, http_res)
+            raise errors.Error502(response_data, http_res)
+        if utils.match_response(http_res, "504", "application/json"):
+            response_data = unmarshal_json_response(errors.Error504Data, http_res)
+            raise errors.Error504(response_data, 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, 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 cancel_async(
+        self,
+        *,
+        transaction_id: str,
+        merchant_account_id: Optional[str] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.TransactionCancel:
+        r"""Cancel transaction
+
+        Cancels a pending transaction. If the transaction was successfully authorized, or was already captured, the cancel will not be processed.
+
+        :param transaction_id: The ID of the transaction
+        :param merchant_account_id: The ID of the merchant account to use for this request.
+        :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 = models.CancelTransactionRequest(
+            transaction_id=transaction_id,
+            merchant_account_id=merchant_account_id,
+        )
+
+        req = self._build_request_async(
+            method="POST",
+            path="/transactions/{transaction_id}/cancel",
+            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=models.CancelTransactionGlobals(
+                merchant_account_id=self.sdk_configuration.globals.merchant_account_id,
+            ),
+            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="cancel_transaction",
+                oauth2_scopes=[],
+                security_source=get_security_from_env(
+                    self.sdk_configuration.security, models.Security
+                ),
+            ),
+            request=req,
+            error_status_codes=[
+                "400",
+                "401",
+                "403",
+                "404",
+                "405",
+                "409",
+                "422",
+                "425",
+                "429",
+                "4XX",
+                "500",
+                "502",
+                "504",
+                "5XX",
+            ],
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.TransactionCancel, http_res)
+        if utils.match_response(http_res, "400", "application/json"):
+            response_data = unmarshal_json_response(errors.Error400Data, http_res)
+            raise errors.Error400(response_data, http_res)
+        if utils.match_response(http_res, "401", "application/json"):
+            response_data = unmarshal_json_response(errors.Error401Data, http_res)
+            raise errors.Error401(response_data, http_res)
+        if utils.match_response(http_res, "403", "application/json"):
+            response_data = unmarshal_json_response(errors.Error403Data, http_res)
+            raise errors.Error403(response_data, http_res)
+        if utils.match_response(http_res, "404", "application/json"):
+            response_data = unmarshal_json_response(errors.Error404Data, http_res)
+            raise errors.Error404(response_data, http_res)
+        if utils.match_response(http_res, "405", "application/json"):
+            response_data = unmarshal_json_response(errors.Error405Data, http_res)
+            raise errors.Error405(response_data, http_res)
+        if utils.match_response(http_res, "409", "application/json"):
+            response_data = unmarshal_json_response(errors.Error409Data, http_res)
+            raise errors.Error409(response_data, http_res)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.HTTPValidationErrorData, http_res
+            )
+            raise errors.HTTPValidationError(response_data, http_res)
+        if utils.match_response(http_res, "425", "application/json"):
+            response_data = unmarshal_json_response(errors.Error425Data, http_res)
+            raise errors.Error425(response_data, http_res)
+        if utils.match_response(http_res, "429", "application/json"):
+            response_data = unmarshal_json_response(errors.Error429Data, http_res)
+            raise errors.Error429(response_data, http_res)
+        if utils.match_response(http_res, "500", "application/json"):
+            response_data = unmarshal_json_response(errors.Error500Data, http_res)
+            raise errors.Error500(response_data, http_res)
+        if utils.match_response(http_res, "502", "application/json"):
+            response_data = unmarshal_json_response(errors.Error502Data, http_res)
+            raise errors.Error502(response_data, http_res)
+        if utils.match_response(http_res, "504", "application/json"):
+            response_data = unmarshal_json_response(errors.Error504Data, http_res)
+            raise errors.Error504(response_data, 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, 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 sync(
         self,
         *,