Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove parts of the API that is no longer publicly documented #1282

Merged
merged 1 commit into from
Mar 28, 2024
Merged

Remove parts of the API that is no longer publicly documented #1282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions stripe/_balance_transaction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,10 +251,6 @@ class RetrieveParams(RequestOptions):
"transfer_cancel",
"transfer_failure",
"transfer_refund",
"obligation_inbound",
"obligation_payout",
"obligation_payout_failure",
"obligation_reversal_outbound",
]
"""
Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.
Expand Down
8 changes: 0 additions & 8 deletions stripe/_event.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,14 +382,6 @@ class RetrieveParams(RequestOptions):
"treasury.received_credit.failed",
"treasury.received_credit.succeeded",
"treasury.received_debit.created",
"invoiceitem.updated",
"order.created",
"recipient.created",
"recipient.deleted",
"recipient.updated",
"sku.created",
"sku.deleted",
"sku.updated",
]
"""
Description of the event (for example, `invoice.created` or `charge.refunded`).
Expand Down
2 changes: 1 addition & 1 deletion stripe/_invoice.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1085,7 +1085,7 @@ class CreateParams(RequestOptions):
Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
"""
pending_invoice_items_behavior: NotRequired[
Literal["exclude", "include", "include_and_require"]
Literal["exclude", "include"]
]
"""
How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.
Expand Down
1 change: 0 additions & 1 deletion stripe/_invoice_line_item.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,6 @@ class ModifyParamsTaxAmountTaxRateData(TypedDict):
"rst",
"sales_tax",
"vat",
"service_tax",
]
]
"""
Expand Down
1 change: 0 additions & 1 deletion stripe/_invoice_line_item_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,6 @@ class UpdateParamsTaxAmountTaxRateData(TypedDict):
"rst",
"sales_tax",
"vat",
"service_tax",
]
]
"""
Expand Down
2 changes: 1 addition & 1 deletion stripe/_invoice_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ class CreateParams(TypedDict):
Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
"""
pending_invoice_items_behavior: NotRequired[
Literal["exclude", "include", "include_and_require"]
Literal["exclude", "include"]
]
"""
How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.
Expand Down
18 changes: 0 additions & 18 deletions stripe/_payment_intent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3230,12 +3230,6 @@ class ConfirmParamsPaymentMethodOptionsCardPresent(TypedDict):
"""
Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
"""
request_incremental_authorization: NotRequired[
Literal["if_available", "never"]
]
"""
This field was released by mistake and will be removed in the next major version
"""

class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict):
ares_trans_status: NotRequired[
Expand Down Expand Up @@ -5371,12 +5365,6 @@ class CreateParamsPaymentMethodOptionsCardPresent(TypedDict):
"""
Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
"""
request_incremental_authorization: NotRequired[
Literal["if_available", "never"]
]
"""
This field was released by mistake and will be removed in the next major version
"""

class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict):
ares_trans_status: NotRequired[
Expand Down Expand Up @@ -7508,12 +7496,6 @@ class ModifyParamsPaymentMethodOptionsCardPresent(TypedDict):
"""
Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
"""
request_incremental_authorization: NotRequired[
Literal["if_available", "never"]
]
"""
This field was released by mistake and will be removed in the next major version
"""

class ModifyParamsPaymentMethodOptionsCardThreeDSecure(TypedDict):
ares_trans_status: NotRequired[
Expand Down
18 changes: 0 additions & 18 deletions stripe/_payment_intent_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1419,12 +1419,6 @@ class ConfirmParamsPaymentMethodOptionsCardPresent(TypedDict):
"""
Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
"""
request_incremental_authorization: NotRequired[
Literal["if_available", "never"]
]
"""
This field was released by mistake and will be removed in the next major version
"""

class ConfirmParamsPaymentMethodOptionsCardThreeDSecure(TypedDict):
ares_trans_status: NotRequired[
Expand Down Expand Up @@ -3584,12 +3578,6 @@ class CreateParamsPaymentMethodOptionsCardPresent(TypedDict):
"""
Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
"""
request_incremental_authorization: NotRequired[
Literal["if_available", "never"]
]
"""
This field was released by mistake and will be removed in the next major version
"""

class CreateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict):
ares_trans_status: NotRequired[
Expand Down Expand Up @@ -5773,12 +5761,6 @@ class UpdateParamsPaymentMethodOptionsCardPresent(TypedDict):
"""
Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.
"""
request_incremental_authorization: NotRequired[
Literal["if_available", "never"]
]
"""
This field was released by mistake and will be removed in the next major version
"""

class UpdateParamsPaymentMethodOptionsCardThreeDSecure(TypedDict):
ares_trans_status: NotRequired[
Expand Down
120 changes: 0 additions & 120 deletions stripe/_payment_method_configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -785,116 +785,6 @@ class DisplayPreference(StripeObject):
display_preference: DisplayPreference
_inner_class_types = {"display_preference": DisplayPreference}

class IdBankTransfer(StripeObject):
class DisplayPreference(StripeObject):
overridable: Optional[bool]
"""
For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
"""
preference: Literal["none", "off", "on"]
"""
The account's display preference.
"""
value: Literal["off", "on"]
"""
The effective display preference value.
"""

available: bool
"""
Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
"""
display_preference: DisplayPreference
_inner_class_types = {"display_preference": DisplayPreference}

class Multibanco(StripeObject):
class DisplayPreference(StripeObject):
overridable: Optional[bool]
"""
For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
"""
preference: Literal["none", "off", "on"]
"""
The account's display preference.
"""
value: Literal["off", "on"]
"""
The effective display preference value.
"""

available: bool
"""
Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
"""
display_preference: DisplayPreference
_inner_class_types = {"display_preference": DisplayPreference}

class Netbanking(StripeObject):
class DisplayPreference(StripeObject):
overridable: Optional[bool]
"""
For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
"""
preference: Literal["none", "off", "on"]
"""
The account's display preference.
"""
value: Literal["off", "on"]
"""
The effective display preference value.
"""

available: bool
"""
Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
"""
display_preference: DisplayPreference
_inner_class_types = {"display_preference": DisplayPreference}

class PayByBank(StripeObject):
class DisplayPreference(StripeObject):
overridable: Optional[bool]
"""
For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
"""
preference: Literal["none", "off", "on"]
"""
The account's display preference.
"""
value: Literal["off", "on"]
"""
The effective display preference value.
"""

available: bool
"""
Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
"""
display_preference: DisplayPreference
_inner_class_types = {"display_preference": DisplayPreference}

class Upi(StripeObject):
class DisplayPreference(StripeObject):
overridable: Optional[bool]
"""
For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
"""
preference: Literal["none", "off", "on"]
"""
The account's display preference.
"""
value: Literal["off", "on"]
"""
The effective display preference value.
"""

available: bool
"""
Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
"""
display_preference: DisplayPreference
_inner_class_types = {"display_preference": DisplayPreference}

class CreateParams(RequestOptions):
acss_debit: NotRequired[
"PaymentMethodConfiguration.CreateParamsAcssDebit"
Expand Down Expand Up @@ -2325,11 +2215,6 @@ class RetrieveParams(RequestOptions):
sofort: Optional[Sofort]
us_bank_account: Optional[UsBankAccount]
wechat_pay: Optional[WechatPay]
id_bank_transfer: Optional[IdBankTransfer]
multibanco: Optional[Multibanco]
netbanking: Optional[Netbanking]
pay_by_bank: Optional[PayByBank]
upi: Optional[Upi]

@classmethod
def create(
Expand Down Expand Up @@ -2435,9 +2320,4 @@ def retrieve(
"sofort": Sofort,
"us_bank_account": UsBankAccount,
"wechat_pay": WechatPay,
"id_bank_transfer": IdBankTransfer,
"multibanco": Multibanco,
"netbanking": Netbanking,
"pay_by_bank": PayByBank,
"upi": Upi,
}
2 changes: 1 addition & 1 deletion stripe/_setup_intent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ class MandateOptions(StripeObject):
Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.
"""
request_three_d_secure: Optional[
Literal["any", "automatic", "challenge", "challenge_only"]
Literal["any", "automatic", "challenge"]
]
"""
We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
Expand Down
3 changes: 0 additions & 3 deletions stripe/_tax_rate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ class CreateParams(RequestOptions):
"rst",
"sales_tax",
"vat",
"service_tax",
]
]
"""
Expand Down Expand Up @@ -180,7 +179,6 @@ class ModifyParams(RequestOptions):
"rst",
"sales_tax",
"vat",
"service_tax",
]
]
"""
Expand Down Expand Up @@ -271,7 +269,6 @@ class RetrieveParams(RequestOptions):
"rst",
"sales_tax",
"vat",
"service_tax",
]
]
"""
Expand Down
2 changes: 0 additions & 2 deletions stripe/_tax_rate_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ class CreateParams(TypedDict):
"rst",
"sales_tax",
"vat",
"service_tax",
]
]
"""
Expand Down Expand Up @@ -173,7 +172,6 @@ class UpdateParams(TypedDict):
"rst",
"sales_tax",
"vat",
"service_tax",
]
]
"""
Expand Down
16 changes: 0 additions & 16 deletions stripe/_webhook_endpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,14 +374,6 @@ class CreateParams(RequestOptions):
"treasury.received_credit.failed",
"treasury.received_credit.succeeded",
"treasury.received_debit.created",
"invoiceitem.updated",
"order.created",
"recipient.created",
"recipient.deleted",
"recipient.updated",
"sku.created",
"sku.deleted",
"sku.updated",
]
]
"""
Expand Down Expand Up @@ -660,14 +652,6 @@ class ModifyParams(RequestOptions):
"treasury.received_credit.failed",
"treasury.received_credit.succeeded",
"treasury.received_debit.created",
"invoiceitem.updated",
"order.created",
"recipient.created",
"recipient.deleted",
"recipient.updated",
"sku.created",
"sku.deleted",
"sku.updated",
]
]
]
Expand Down
16 changes: 0 additions & 16 deletions stripe/_webhook_endpoint_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,14 +355,6 @@ class CreateParams(TypedDict):
"treasury.received_credit.failed",
"treasury.received_credit.succeeded",
"treasury.received_debit.created",
"invoiceitem.updated",
"order.created",
"recipient.created",
"recipient.deleted",
"recipient.updated",
"sku.created",
"sku.deleted",
"sku.updated",
]
]
"""
Expand Down Expand Up @@ -647,14 +639,6 @@ class UpdateParams(TypedDict):
"treasury.received_credit.failed",
"treasury.received_credit.succeeded",
"treasury.received_debit.created",
"invoiceitem.updated",
"order.created",
"recipient.created",
"recipient.deleted",
"recipient.updated",
"sku.created",
"sku.deleted",
"sku.updated",
]
]
]
Expand Down
1 change: 0 additions & 1 deletion stripe/climate/_supplier.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ class RetrieveParams(RequestOptions):
"biomass_carbon_removal_and_storage",
"direct_air_capture",
"enhanced_weathering",
"various",
]
"""
The scientific pathway used for carbon removal.
Expand Down
Loading
Loading