gr4vy 1.5.6__py3-none-any.whl → 1.7.1__py3-none-any.whl

gr4vy/models/checkoutsession.py

@@ -3,9 +3,9 @@
 from __future__ import annotations
 from .airline import Airline, AirlineTypedDict
 from .cartitem import CartItem, CartItemTypedDict
-from .checkoutsessionpaymentmethod import (
-    CheckoutSessionPaymentMethod,
-    CheckoutSessionPaymentMethodTypedDict,
+from .checkoutsessionpaymentmethod_output import (
+    CheckoutSessionPaymentMethodOutput,
+    CheckoutSessionPaymentMethodOutputTypedDict,
 )
 from .guestbuyer_output import GuestBuyerOutput, GuestBuyerOutputTypedDict
 from datetime import datetime
@@ -31,9 +31,15 @@ class CheckoutSessionTypedDict(TypedDict):
     r"""Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used."""
     airline: NotRequired[Nullable[AirlineTypedDict]]
     r"""The airline addendum data which describes the airline booking associated with this transaction."""
+    amount: NotRequired[Nullable[int]]
+    r"""The total amount for this transaction."""
+    currency: NotRequired[Nullable[str]]
+    r"""The currency code for this transaction."""
+    payment_service_id: NotRequired[Nullable[str]]
+    r"""The unique identifier of an existing payment service. When provided, the created transaction will be processed by the given payment service and any routing rules will be skipped."""
     type: Literal["checkout-session"]
     r"""Always `checkout-session`"""
-    payment_method: NotRequired[Nullable[CheckoutSessionPaymentMethodTypedDict]]
+    payment_method: NotRequired[Nullable[CheckoutSessionPaymentMethodOutputTypedDict]]
     r"""Information about the payment method stored on the checkout session."""
 
 
@@ -56,6 +62,15 @@ class CheckoutSession(BaseModel):
     airline: OptionalNullable[Airline] = UNSET
     r"""The airline addendum data which describes the airline booking associated with this transaction."""
 
+    amount: OptionalNullable[int] = UNSET
+    r"""The total amount for this transaction."""
+
+    currency: OptionalNullable[str] = UNSET
+    r"""The currency code for this transaction."""
+
+    payment_service_id: OptionalNullable[str] = UNSET
+    r"""The unique identifier of an existing payment service. When provided, the created transaction will be processed by the given payment service and any routing rules will be skipped."""
+
     TYPE: Annotated[
         Annotated[
             Optional[Literal["checkout-session"]],
@@ -65,7 +80,7 @@ class CheckoutSession(BaseModel):
     ] = "checkout-session"
     r"""Always `checkout-session`"""
 
-    payment_method: OptionalNullable[CheckoutSessionPaymentMethod] = UNSET
+    payment_method: OptionalNullable[CheckoutSessionPaymentMethodOutput] = UNSET
     r"""Information about the payment method stored on the checkout session."""
 
     @model_serializer(mode="wrap")
@@ -75,6 +90,9 @@ class CheckoutSession(BaseModel):
             "metadata",
             "buyer",
             "airline",
+            "amount",
+            "currency",
+            "payment_service_id",
             "type",
             "payment_method",
         ]
@@ -83,6 +101,9 @@ class CheckoutSession(BaseModel):
             "metadata",
             "buyer",
             "airline",
+            "amount",
+            "currency",
+            "payment_service_id",
             "payment_method",
         ]
         null_default_fields = []

gr4vy/models/checkoutsessioncreate.py

@@ -19,7 +19,14 @@ class CheckoutSessionCreateTypedDict(TypedDict):
     r"""Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used."""
     airline: NotRequired[Nullable[AirlineTypedDict]]
     r"""The airline addendum data which describes the airline booking associated with this transaction."""
+    amount: NotRequired[Nullable[int]]
+    r"""The total amount for this transaction."""
+    currency: NotRequired[Nullable[str]]
+    r"""The currency code for this transaction."""
+    payment_service_id: NotRequired[Nullable[str]]
+    r"""The unique identifier of an existing payment service. When provided, the created transaction will be processed by the given payment service and any routing rules will be skipped."""
     expires_in: NotRequired[float]
+    r"""The time in seconds when this checkout session expires."""
 
 
 class CheckoutSessionCreate(BaseModel):
@@ -35,12 +42,39 @@ class CheckoutSessionCreate(BaseModel):
     airline: OptionalNullable[Airline] = UNSET
     r"""The airline addendum data which describes the airline booking associated with this transaction."""
 
+    amount: OptionalNullable[int] = UNSET
+    r"""The total amount for this transaction."""
+
+    currency: OptionalNullable[str] = UNSET
+    r"""The currency code for this transaction."""
+
+    payment_service_id: OptionalNullable[str] = UNSET
+    r"""The unique identifier of an existing payment service. When provided, the created transaction will be processed by the given payment service and any routing rules will be skipped."""
+
     expires_in: Optional[float] = 3600
+    r"""The time in seconds when this checkout session expires."""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["cart_items", "metadata", "buyer", "airline", "expires_in"]
-        nullable_fields = ["cart_items", "metadata", "buyer", "airline"]
+        optional_fields = [
+            "cart_items",
+            "metadata",
+            "buyer",
+            "airline",
+            "amount",
+            "currency",
+            "payment_service_id",
+            "expires_in",
+        ]
+        nullable_fields = [
+            "cart_items",
+            "metadata",
+            "buyer",
+            "airline",
+            "amount",
+            "currency",
+            "payment_service_id",
+        ]
         null_default_fields = []
 
         serialized = handler(self)

gr4vy/models/{checkoutsessionpaymentmethod.py → checkoutsessionpaymentmethod_output.py}

@@ -15,7 +15,7 @@ from typing import Literal, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class CheckoutSessionPaymentMethodTypedDict(TypedDict):
+class CheckoutSessionPaymentMethodOutputTypedDict(TypedDict):
     type: Literal["payment-method"]
     r"""Always `payment-method`"""
     id: NotRequired[Nullable[str]]
@@ -32,7 +32,7 @@ class CheckoutSessionPaymentMethodTypedDict(TypedDict):
     r"""The unique hash derived from the card number."""
 
 
-class CheckoutSessionPaymentMethod(BaseModel):
+class CheckoutSessionPaymentMethodOutput(BaseModel):
     TYPE: Annotated[
         Annotated[
             Optional[Literal["payment-method"]],

gr4vy/models/create_payment_methodop.py

@@ -9,6 +9,10 @@ from .checkoutsessionpaymentmethodcreate import (
     CheckoutSessionPaymentMethodCreate,
     CheckoutSessionPaymentMethodCreateTypedDict,
 )
+from .plaidpaymentmethodcreate import (
+    PlaidPaymentMethodCreate,
+    PlaidPaymentMethodCreateTypedDict,
+)
 from .redirectpaymentmethodcreate import (
     RedirectPaymentMethodCreate,
     RedirectPaymentMethodCreateTypedDict,
@@ -38,6 +42,7 @@ BodyTypedDict = TypeAliasType(
     "BodyTypedDict",
     Union[
         CheckoutSessionPaymentMethodCreateTypedDict,
+        PlaidPaymentMethodCreateTypedDict,
         RedirectPaymentMethodCreateTypedDict,
         CardPaymentMethodCreateTypedDict,
     ],
@@ -48,6 +53,7 @@ Body = TypeAliasType(
     "Body",
     Union[
         CheckoutSessionPaymentMethodCreate,
+        PlaidPaymentMethodCreate,
         RedirectPaymentMethodCreate,
         CardPaymentMethodCreate,
     ],

gr4vy/models/forterantifraudoptionscartitembasicitemdata.py

@@ -16,7 +16,7 @@ from typing import Literal, Union
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-Type = Union[
+ForterAntiFraudOptionsCartItemBasicItemDataType = Union[
     Literal[
         "TANGIBLE",
         "NON_TANGIBLE",
@@ -26,13 +26,14 @@ Type = Union[
 
 
 class ForterAntiFraudOptionsCartItemBasicItemDataTypedDict(TypedDict):
-    type: NotRequired[Nullable[Type]]
+    type: NotRequired[Nullable[ForterAntiFraudOptionsCartItemBasicItemDataType]]
     r"""Indicates whether the item is a physical good or a service/digital item."""
 
 
 class ForterAntiFraudOptionsCartItemBasicItemData(BaseModel):
     type: Annotated[
-        OptionalNullable[Type], PlainValidator(validate_open_enum(False))
+        OptionalNullable[ForterAntiFraudOptionsCartItemBasicItemDataType],
+        PlainValidator(validate_open_enum(False)),
     ] = UNSET
     r"""Indicates whether the item is a physical good or a service/digital item."""
 

gr4vy/models/instrumenttype.py

@@ -14,6 +14,7 @@ InstrumentType = Union[
         "googlepay",
         "applepay",
         "network_token",
+        "plaid",
     ],
     UnrecognizedStr,
 ]

gr4vy/models/integrationclient.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from gr4vy.types import UnrecognizedStr
+from typing import Literal, Union
+
+
+IntegrationClient = Union[
+    Literal[
+        "redirect",
+        "web",
+        "android",
+        "ios",
+    ],
+    UnrecognizedStr,
+]

gr4vy/models/monatospeioptions.py

@@ -0,0 +1,15 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from gr4vy.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class MonatoSpeiOptionsTypedDict(TypedDict):
+    approval_url: str
+    r"""Approval URL that will receive a charge payment method reference."""
+
+
+class MonatoSpeiOptions(BaseModel):
+    approval_url: str
+    r"""Approval URL that will receive a charge payment method reference."""

gr4vy/models/paymentlink.py

@@ -5,7 +5,10 @@ from .cartitem import CartItem, CartItemTypedDict
 from .paymentlinkstatus import PaymentLinkStatus
 from .shippingdetails import ShippingDetails, ShippingDetailsTypedDict
 from .statementdescriptor import StatementDescriptor, StatementDescriptorTypedDict
-from .transactionbuyer import TransactionBuyer, TransactionBuyerTypedDict
+from .transactionbuyer_output import (
+    TransactionBuyerOutput,
+    TransactionBuyerOutputTypedDict,
+)
 from .transactionintent import TransactionIntent
 from .transactionpaymentsource import TransactionPaymentSource
 from datetime import datetime
@@ -67,7 +70,7 @@ class PaymentLinkTypedDict(TypedDict):
     r"""The return URL after payment completion."""
     metadata: NotRequired[Nullable[Dict[str, Any]]]
     r"""Arbitrary metadata for the payment link."""
-    buyer: NotRequired[Nullable[TransactionBuyerTypedDict]]
+    buyer: NotRequired[Nullable[TransactionBuyerOutputTypedDict]]
     r"""The buyer associated with the payment link."""
     shipping_details: NotRequired[Nullable[ShippingDetailsTypedDict]]
     r"""The shipping details for the payment link."""
@@ -157,7 +160,7 @@ class PaymentLink(BaseModel):
     metadata: OptionalNullable[Dict[str, Any]] = UNSET
     r"""Arbitrary metadata for the payment link."""
 
-    buyer: OptionalNullable[TransactionBuyer] = UNSET
+    buyer: OptionalNullable[TransactionBuyerOutput] = UNSET
     r"""The buyer associated with the payment link."""
 
     shipping_details: OptionalNullable[ShippingDetails] = UNSET

gr4vy/models/paymentmethodsummaries.py

@@ -1,17 +1,20 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .paymentmethodsummary import PaymentMethodSummary, PaymentMethodSummaryTypedDict
+from .paymentmethodsummary_output import (
+    PaymentMethodSummaryOutput,
+    PaymentMethodSummaryOutputTypedDict,
+)
 from gr4vy.types import BaseModel
 from typing import List
 from typing_extensions import TypedDict
 
 
 class PaymentMethodSummariesTypedDict(TypedDict):
-    items: List[PaymentMethodSummaryTypedDict]
+    items: List[PaymentMethodSummaryOutputTypedDict]
     r"""A list of items returned for this request."""
 
 
 class PaymentMethodSummaries(BaseModel):
-    items: List[PaymentMethodSummary]
+    items: List[PaymentMethodSummaryOutput]
     r"""A list of items returned for this request."""

gr4vy/models/{paymentmethodsummary.py → paymentmethodsummary_output.py}

@@ -18,7 +18,7 @@ from typing import List, Literal, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class PaymentMethodSummaryTypedDict(TypedDict):
+class PaymentMethodSummaryOutputTypedDict(TypedDict):
     r"""Payment Method
 
     A summary of a payment method.
@@ -65,7 +65,7 @@ class PaymentMethodSummaryTypedDict(TypedDict):
     r"""The timestamp when this payment method was last used in a transaction."""
 
 
-class PaymentMethodSummary(BaseModel):
+class PaymentMethodSummaryOutput(BaseModel):
     r"""Payment Method
 
     A summary of a payment method.

gr4vy/models/{paymentoption.py → paymentoption_output.py}

@@ -38,7 +38,7 @@ Context = TypeAliasType(
 )
 
 
-class PaymentOptionTypedDict(TypedDict):
+class PaymentOptionOutputTypedDict(TypedDict):
     method: str
     mode: Mode
     can_store_payment_method: bool
@@ -49,7 +49,7 @@ class PaymentOptionTypedDict(TypedDict):
     context: NotRequired[Nullable[ContextTypedDict]]
 
 
-class PaymentOption(BaseModel):
+class PaymentOptionOutput(BaseModel):
     method: str
 
     mode: Annotated[Mode, PlainValidator(validate_open_enum(False))]

gr4vy/models/paymentoptions.py

@@ -1,17 +1,17 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .paymentoption import PaymentOption, PaymentOptionTypedDict
+from .paymentoption_output import PaymentOptionOutput, PaymentOptionOutputTypedDict
 from gr4vy.types import BaseModel
 from typing import List
 from typing_extensions import TypedDict
 
 
 class PaymentOptionsTypedDict(TypedDict):
-    items: List[PaymentOptionTypedDict]
+    items: List[PaymentOptionOutputTypedDict]
     r"""A list of items returned for this request."""
 
 
 class PaymentOptions(BaseModel):
-    items: List[PaymentOption]
+    items: List[PaymentOptionOutput]
     r"""A list of items returned for this request."""

gr4vy/models/paymentservicedefinition.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 from .definitionfield import DefinitionField, DefinitionFieldTypedDict
+from .integrationclient import IntegrationClient
 from .method import Method
 from .mode import Mode
 from .paymentserviceconfiguration import (
@@ -41,6 +42,8 @@ class PaymentServiceDefinitionTypedDict(TypedDict):
     required_checkout_fields: List[RequiredCheckoutFieldsTypedDict]
     r"""A list of condition that define when some fields must be provided with a transaction request."""
     configuration: PaymentServiceConfigurationTypedDict
+    supported_integration_clients: Nullable[List[IntegrationClient]]
+    r"""List of supported integration clients. Defaults to redirect for most redirect connectors."""
     type: Literal["payment-service-definition"]
     r"""Always `payment-service-definition`."""
     icon_url: NotRequired[Nullable[str]]
@@ -78,6 +81,11 @@ class PaymentServiceDefinition(BaseModel):
 
     configuration: PaymentServiceConfiguration
 
+    supported_integration_clients: Nullable[
+        List[Annotated[IntegrationClient, PlainValidator(validate_open_enum(False))]]
+    ]
+    r"""List of supported integration clients. Defaults to redirect for most redirect connectors."""
+
     TYPE: Annotated[
         Annotated[
             Optional[Literal["payment-service-definition"]],
@@ -93,7 +101,7 @@ class PaymentServiceDefinition(BaseModel):
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
         optional_fields = ["type", "icon_url"]
-        nullable_fields = ["icon_url"]
+        nullable_fields = ["icon_url", "supported_integration_clients"]
         null_default_fields = []
 
         serialized = handler(self)

gr4vy/models/payoutsummary.py

@@ -5,10 +5,13 @@ from .payoutcategory import PayoutCategory
 from .payoutmerchantsummary import PayoutMerchantSummary, PayoutMerchantSummaryTypedDict
 from .payoutpaymentservice import PayoutPaymentService, PayoutPaymentServiceTypedDict
 from .payoutstatus import PayoutStatus
-from .transactionbuyer import TransactionBuyer, TransactionBuyerTypedDict
-from .transactionpaymentmethod import (
-    TransactionPaymentMethod,
-    TransactionPaymentMethodTypedDict,
+from .transactionbuyer_output import (
+    TransactionBuyerOutput,
+    TransactionBuyerOutputTypedDict,
+)
+from .transactionpaymentmethod_output import (
+    TransactionPaymentMethodOutput,
+    TransactionPaymentMethodOutputTypedDict,
 )
 from datetime import datetime
 from gr4vy.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
@@ -32,7 +35,7 @@ class PayoutSummaryTypedDict(TypedDict):
     r"""The date this payout was created at."""
     currency: str
     r"""A supported ISO-4217 currency code."""
-    payment_method: TransactionPaymentMethodTypedDict
+    payment_method: TransactionPaymentMethodOutputTypedDict
     payment_service: PayoutPaymentServiceTypedDict
     status: PayoutStatus
     updated_at: datetime
@@ -41,7 +44,7 @@ class PayoutSummaryTypedDict(TypedDict):
     r"""Always `payout`."""
     id: NotRequired[Nullable[str]]
     r"""The ID for the payout."""
-    buyer: NotRequired[Nullable[TransactionBuyerTypedDict]]
+    buyer: NotRequired[Nullable[TransactionBuyerOutputTypedDict]]
     r"""The buyer used for this payout."""
     category: NotRequired[Nullable[PayoutCategory]]
     r"""The type of payout to process."""
@@ -70,7 +73,7 @@ class PayoutSummary(BaseModel):
     currency: str
     r"""A supported ISO-4217 currency code."""
 
-    payment_method: TransactionPaymentMethod
+    payment_method: TransactionPaymentMethodOutput
 
     payment_service: PayoutPaymentService
 
@@ -90,7 +93,7 @@ class PayoutSummary(BaseModel):
     id: OptionalNullable[str] = UNSET
     r"""The ID for the payout."""
 
-    buyer: OptionalNullable[TransactionBuyer] = UNSET
+    buyer: OptionalNullable[TransactionBuyerOutput] = UNSET
     r"""The buyer used for this payout."""
 
     category: Annotated[

gr4vy/models/paypaloptions.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .paypalshippingoptions import PaypalShippingOptions, PaypalShippingOptionsTypedDict
 from gr4vy.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
 from pydantic import model_serializer
 from typing import Dict, List
@@ -10,16 +11,21 @@ from typing_extensions import NotRequired, TypedDict
 class PaypalOptionsTypedDict(TypedDict):
     additional_data: NotRequired[Nullable[List[Dict[str, str]]]]
     r"""Additional Set Transaction Context Values (STC) to be sent to PayPal as part of the transaction."""
+    shipping: NotRequired[Nullable[PaypalShippingOptionsTypedDict]]
+    r"""Shipping information to be passed to the PayPal API."""
 
 
 class PaypalOptions(BaseModel):
     additional_data: OptionalNullable[List[Dict[str, str]]] = UNSET
     r"""Additional Set Transaction Context Values (STC) to be sent to PayPal as part of the transaction."""
 
+    shipping: OptionalNullable[PaypalShippingOptions] = UNSET
+    r"""Shipping information to be passed to the PayPal API."""
+
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["additional_data"]
-        nullable_fields = ["additional_data"]
+        optional_fields = ["additional_data", "shipping"]
+        nullable_fields = ["additional_data", "shipping"]
         null_default_fields = []
 
         serialized = handler(self)

gr4vy/models/paypalshippingoptions.py

@@ -0,0 +1,51 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paypalshippingoptionsitem import (
+    PaypalShippingOptionsItem,
+    PaypalShippingOptionsItemTypedDict,
+)
+from gr4vy.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL
+from pydantic import model_serializer
+from typing import List
+from typing_extensions import NotRequired, TypedDict
+
+
+class PaypalShippingOptionsTypedDict(TypedDict):
+    options: NotRequired[Nullable[List[PaypalShippingOptionsItemTypedDict]]]
+    r"""Shipping options that the payee or merchant offers to the payer to ship or pick up their items."""
+
+
+class PaypalShippingOptions(BaseModel):
+    options: OptionalNullable[List[PaypalShippingOptionsItem]] = UNSET
+    r"""Shipping options that the payee or merchant offers to the payer to ship or pick up their items."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["options"]
+        nullable_fields = ["options"]
+        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/models/paypalshippingoptionsitem.py

@@ -0,0 +1,94 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .paypalshippingoptionsitemamount import (
+    PaypalShippingOptionsItemAmount,
+    PaypalShippingOptionsItemAmountTypedDict,
+)
+from gr4vy.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+    UnrecognizedStr,
+)
+from gr4vy.utils import validate_open_enum
+from pydantic import model_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import Literal, Union
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+PaypalShippingOptionsItemType = Union[
+    Literal[
+        "SHIPPING",
+        "PICKUP",
+        "PICKUP_IN_STORE",
+        "PICKUP_FROM_PERSON",
+    ],
+    UnrecognizedStr,
+]
+
+
+class PaypalShippingOptionsItemTypedDict(TypedDict):
+    id: str
+    r"""A unique ID that identifies a payer-selected shipping option."""
+    label: str
+    r"""A description that the payer sees, which helps them choose an appropriate shipping option."""
+    selected: bool
+    r"""If the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. Only one shipping.option can be set to selected=true."""
+    type: NotRequired[Nullable[PaypalShippingOptionsItemType]]
+    r"""A classification for the method of purchase fulfillment."""
+    amount: NotRequired[Nullable[PaypalShippingOptionsItemAmountTypedDict]]
+    r"""The shipping cost for the selected option."""
+
+
+class PaypalShippingOptionsItem(BaseModel):
+    id: str
+    r"""A unique ID that identifies a payer-selected shipping option."""
+
+    label: str
+    r"""A description that the payer sees, which helps them choose an appropriate shipping option."""
+
+    selected: bool
+    r"""If the API request sets selected = true, it represents the shipping option that the payee or merchant expects to be pre-selected for the payer when they first view the shipping.options in the PayPal Checkout experience. Only one shipping.option can be set to selected=true."""
+
+    type: Annotated[
+        OptionalNullable[PaypalShippingOptionsItemType],
+        PlainValidator(validate_open_enum(False)),
+    ] = UNSET
+    r"""A classification for the method of purchase fulfillment."""
+
+    amount: OptionalNullable[PaypalShippingOptionsItemAmount] = UNSET
+    r"""The shipping cost for the selected option."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["type", "amount"]
+        nullable_fields = ["type", "amount"]
+        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/models/paypalshippingoptionsitemamount.py

@@ -0,0 +1,20 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from gr4vy.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class PaypalShippingOptionsItemAmountTypedDict(TypedDict):
+    currency_code: str
+    r"""The three-character ISO currency code."""
+    value: str
+    r"""The amount value, which might include a decimal portion."""
+
+
+class PaypalShippingOptionsItemAmount(BaseModel):
+    currency_code: str
+    r"""The three-character ISO currency code."""
+
+    value: str
+    r"""The amount value, which might include a decimal portion."""