gr4vy 1.2.0__tar.gz → 1.2.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: gr4vy
-Version: 1.2.0
+Version: 1.2.2
 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.2}/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.2}/pyproject.toml

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

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

@@ -3,10 +3,10 @@
 import importlib.metadata
 
 __title__: str = "gr4vy"
-__version__: str = "1.2.0"
+__version__: str = "1.2.2"
 __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"
+__gen_version__: str = "2.690.1"
+__user_agent__: str = "speakeasy-sdk/python 1.2.2 2.690.1 1.0.0 gr4vy"
 
 try:
     if __package__ is not None:

{gr4vy-1.2.0 → gr4vy-1.2.2}/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.2/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.2/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.0 → gr4vy-1.2.2}/src/gr4vy/models/settlement.py

@@ -15,21 +15,21 @@ class SettlementTypedDict(TypedDict):
     r"""A settlement record for a transaction."""
 
     id: str
-    r"""The unique identifier for the settlement."""
+    r"""The unique identifier for the record."""
     merchant_account_id: str
-    r"""The merchant account this settlement belongs to."""
+    r"""The merchant account this record belongs to."""
     created_at: datetime
-    r"""The date and time the settlement was created, in ISO 8601 format."""
+    r"""The date and time the record was created, in ISO 8601 format."""
     updated_at: datetime
-    r"""The date and time the settlement was last updated, in ISO 8601 format."""
+    r"""The date and time the record was last updated, in ISO 8601 format."""
     posted_at: datetime
-    r"""The date and time the settlement was posted, in ISO 8601 format."""
+    r"""The date and time the record was posted, in ISO 8601 format."""
     ingested_at: datetime
-    r"""The date and time the settlement was ingested, in ISO 8601 format."""
+    r"""The date and time the record was ingested, in ISO 8601 format."""
     currency: str
-    r"""ISO 4217 currency code for the settlement."""
+    r"""ISO 4217 currency code."""
     amount: int
-    r"""The total settled amount in the smallest currency unit (e.g. cents)."""
+    r"""The total amount in the smallest currency unit (e.g. cents)."""
     commission: int
     r"""The commission amount deducted in the smallest currency unit."""
     payment_service_report_id: str
@@ -37,45 +37,45 @@ class SettlementTypedDict(TypedDict):
     payment_service_report_file_ids: List[str]
     r"""List of file IDs for the payment service report."""
     transaction_id: str
-    r"""The transaction this settlement is associated with."""
-    type: Literal["settlement"]
-    r"""Always 'settlement'."""
+    r"""The transaction this record is associated with."""
     exchange_rate: NotRequired[Nullable[float]]
-    r"""The exchange rate used for settlement, if applicable."""
+    r"""The exchange rate, if applicable."""
     interchange: NotRequired[Nullable[int]]
     r"""The interchange fee, if applicable, in the smallest currency unit."""
     markup: NotRequired[Nullable[int]]
     r"""The markup fee, if applicable, in the smallest currency unit."""
     scheme_fee: NotRequired[Nullable[int]]
     r"""The scheme fee, if applicable, in the smallest currency unit."""
+    type: Literal["settlement"]
+    r"""Always `settlement`."""
 
 
 class Settlement(BaseModel):
     r"""A settlement record for a transaction."""
 
     id: str
-    r"""The unique identifier for the settlement."""
+    r"""The unique identifier for the record."""
 
     merchant_account_id: str
-    r"""The merchant account this settlement belongs to."""
+    r"""The merchant account this record belongs to."""
 
     created_at: datetime
-    r"""The date and time the settlement was created, in ISO 8601 format."""
+    r"""The date and time the record was created, in ISO 8601 format."""
 
     updated_at: datetime
-    r"""The date and time the settlement was last updated, in ISO 8601 format."""
+    r"""The date and time the record was last updated, in ISO 8601 format."""
 
     posted_at: datetime
-    r"""The date and time the settlement was posted, in ISO 8601 format."""
+    r"""The date and time the record was posted, in ISO 8601 format."""
 
     ingested_at: datetime
-    r"""The date and time the settlement was ingested, in ISO 8601 format."""
+    r"""The date and time the record was ingested, in ISO 8601 format."""
 
     currency: str
-    r"""ISO 4217 currency code for the settlement."""
+    r"""ISO 4217 currency code."""
 
     amount: int
-    r"""The total settled amount in the smallest currency unit (e.g. cents)."""
+    r"""The total amount in the smallest currency unit (e.g. cents)."""
 
     commission: int
     r"""The commission amount deducted in the smallest currency unit."""
@@ -87,19 +87,10 @@ class Settlement(BaseModel):
     r"""List of file IDs for the payment service report."""
 
     transaction_id: str
-    r"""The transaction this settlement is associated with."""
-
-    TYPE: Annotated[
-        Annotated[
-            Optional[Literal["settlement"]],
-            AfterValidator(validate_const("settlement")),
-        ],
-        pydantic.Field(alias="type"),
-    ] = "settlement"
-    r"""Always 'settlement'."""
+    r"""The transaction this record is associated with."""
 
     exchange_rate: OptionalNullable[float] = UNSET
-    r"""The exchange rate used for settlement, if applicable."""
+    r"""The exchange rate, if applicable."""
 
     interchange: OptionalNullable[int] = UNSET
     r"""The interchange fee, if applicable, in the smallest currency unit."""
@@ -110,14 +101,23 @@ class Settlement(BaseModel):
     scheme_fee: OptionalNullable[int] = UNSET
     r"""The scheme fee, if applicable, in the smallest currency unit."""
 
+    TYPE: Annotated[
+        Annotated[
+            Optional[Literal["settlement"]],
+            AfterValidator(validate_const("settlement")),
+        ],
+        pydantic.Field(alias="type"),
+    ] = "settlement"
+    r"""Always `settlement`."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = [
-            "type",
             "exchange_rate",
             "interchange",
             "markup",
             "scheme_fee",
+            "type",
         ]
         nullable_fields = ["exchange_rate", "interchange", "markup", "scheme_fee"]
         null_default_fields = []

gr4vy-1.2.2/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