updates
This commit is contained in:
File diff suppressed because it is too large
Load Diff
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,20 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired
|
||||
|
||||
|
||||
class AuthorizationApproveParams(RequestOptions):
|
||||
amount: NotRequired[int]
|
||||
"""
|
||||
If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
metadata: NotRequired["Literal['']|Dict[str, str]"]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
@@ -0,0 +1,273 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class AuthorizationCaptureParams(RequestOptions):
|
||||
capture_amount: NotRequired[int]
|
||||
"""
|
||||
The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||||
"""
|
||||
close_authorization: NotRequired[bool]
|
||||
"""
|
||||
Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
purchase_details: NotRequired["AuthorizationCaptureParamsPurchaseDetails"]
|
||||
"""
|
||||
Additional purchase information that is optionally provided by the merchant.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetails(TypedDict):
|
||||
fleet: NotRequired["AuthorizationCaptureParamsPurchaseDetailsFleet"]
|
||||
"""
|
||||
Fleet-specific information for transactions using Fleet cards.
|
||||
"""
|
||||
flight: NotRequired["AuthorizationCaptureParamsPurchaseDetailsFlight"]
|
||||
"""
|
||||
Information about the flight that was purchased with this transaction.
|
||||
"""
|
||||
fuel: NotRequired["AuthorizationCaptureParamsPurchaseDetailsFuel"]
|
||||
"""
|
||||
Information about fuel that was purchased with this transaction.
|
||||
"""
|
||||
lodging: NotRequired["AuthorizationCaptureParamsPurchaseDetailsLodging"]
|
||||
"""
|
||||
Information about lodging that was purchased with this transaction.
|
||||
"""
|
||||
receipt: NotRequired[
|
||||
List["AuthorizationCaptureParamsPurchaseDetailsReceipt"]
|
||||
]
|
||||
"""
|
||||
The line items in the purchase.
|
||||
"""
|
||||
reference: NotRequired[str]
|
||||
"""
|
||||
A merchant-specific order number.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsFleet(TypedDict):
|
||||
cardholder_prompt_data: NotRequired[
|
||||
"AuthorizationCaptureParamsPurchaseDetailsFleetCardholderPromptData"
|
||||
]
|
||||
"""
|
||||
Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
|
||||
"""
|
||||
purchase_type: NotRequired[
|
||||
Literal[
|
||||
"fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase"
|
||||
]
|
||||
]
|
||||
"""
|
||||
The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
|
||||
"""
|
||||
reported_breakdown: NotRequired[
|
||||
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdown"
|
||||
]
|
||||
"""
|
||||
More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
|
||||
"""
|
||||
service_type: NotRequired[
|
||||
Literal["full_service", "non_fuel_transaction", "self_service"]
|
||||
]
|
||||
"""
|
||||
The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsFleetCardholderPromptData(
|
||||
TypedDict,
|
||||
):
|
||||
driver_id: NotRequired[str]
|
||||
"""
|
||||
Driver ID.
|
||||
"""
|
||||
odometer: NotRequired[int]
|
||||
"""
|
||||
Odometer reading.
|
||||
"""
|
||||
unspecified_id: NotRequired[str]
|
||||
"""
|
||||
An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
|
||||
"""
|
||||
user_id: NotRequired[str]
|
||||
"""
|
||||
User ID.
|
||||
"""
|
||||
vehicle_number: NotRequired[str]
|
||||
"""
|
||||
Vehicle number.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdown(
|
||||
TypedDict,
|
||||
):
|
||||
fuel: NotRequired[
|
||||
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel"
|
||||
]
|
||||
"""
|
||||
Breakdown of fuel portion of the purchase.
|
||||
"""
|
||||
non_fuel: NotRequired[
|
||||
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel"
|
||||
]
|
||||
"""
|
||||
Breakdown of non-fuel portion of the purchase.
|
||||
"""
|
||||
tax: NotRequired[
|
||||
"AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownTax"
|
||||
]
|
||||
"""
|
||||
Information about tax included in this transaction.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownFuel(
|
||||
TypedDict,
|
||||
):
|
||||
gross_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownNonFuel(
|
||||
TypedDict,
|
||||
):
|
||||
gross_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsFleetReportedBreakdownTax(
|
||||
TypedDict,
|
||||
):
|
||||
local_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
|
||||
"""
|
||||
national_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsFlight(TypedDict):
|
||||
departure_at: NotRequired[int]
|
||||
"""
|
||||
The time that the flight departed.
|
||||
"""
|
||||
passenger_name: NotRequired[str]
|
||||
"""
|
||||
The name of the passenger.
|
||||
"""
|
||||
refundable: NotRequired[bool]
|
||||
"""
|
||||
Whether the ticket is refundable.
|
||||
"""
|
||||
segments: NotRequired[
|
||||
List["AuthorizationCaptureParamsPurchaseDetailsFlightSegment"]
|
||||
]
|
||||
"""
|
||||
The legs of the trip.
|
||||
"""
|
||||
travel_agency: NotRequired[str]
|
||||
"""
|
||||
The travel agency that issued the ticket.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsFlightSegment(TypedDict):
|
||||
arrival_airport_code: NotRequired[str]
|
||||
"""
|
||||
The three-letter IATA airport code of the flight's destination.
|
||||
"""
|
||||
carrier: NotRequired[str]
|
||||
"""
|
||||
The airline carrier code.
|
||||
"""
|
||||
departure_airport_code: NotRequired[str]
|
||||
"""
|
||||
The three-letter IATA airport code that the flight departed from.
|
||||
"""
|
||||
flight_number: NotRequired[str]
|
||||
"""
|
||||
The flight number.
|
||||
"""
|
||||
service_class: NotRequired[str]
|
||||
"""
|
||||
The flight's service class.
|
||||
"""
|
||||
stopover_allowed: NotRequired[bool]
|
||||
"""
|
||||
Whether a stopover is allowed on this flight.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsFuel(TypedDict):
|
||||
industry_product_code: NotRequired[str]
|
||||
"""
|
||||
[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
|
||||
"""
|
||||
quantity_decimal: NotRequired[str]
|
||||
"""
|
||||
The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
|
||||
"""
|
||||
type: NotRequired[
|
||||
Literal[
|
||||
"diesel",
|
||||
"other",
|
||||
"unleaded_plus",
|
||||
"unleaded_regular",
|
||||
"unleaded_super",
|
||||
]
|
||||
]
|
||||
"""
|
||||
The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
|
||||
"""
|
||||
unit: NotRequired[
|
||||
Literal[
|
||||
"charging_minute",
|
||||
"imperial_gallon",
|
||||
"kilogram",
|
||||
"kilowatt_hour",
|
||||
"liter",
|
||||
"other",
|
||||
"pound",
|
||||
"us_gallon",
|
||||
]
|
||||
]
|
||||
"""
|
||||
The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
|
||||
"""
|
||||
unit_cost_decimal: NotRequired[str]
|
||||
"""
|
||||
The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsLodging(TypedDict):
|
||||
check_in_at: NotRequired[int]
|
||||
"""
|
||||
The time of checking into the lodging.
|
||||
"""
|
||||
nights: NotRequired[int]
|
||||
"""
|
||||
The number of nights stayed at the lodging.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCaptureParamsPurchaseDetailsReceipt(TypedDict):
|
||||
description: NotRequired[str]
|
||||
quantity: NotRequired[str]
|
||||
total: NotRequired[int]
|
||||
unit_cost: NotRequired[int]
|
||||
@@ -0,0 +1,674 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class AuthorizationCreateParams(RequestOptions):
|
||||
amount: NotRequired[int]
|
||||
"""
|
||||
The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||||
"""
|
||||
amount_details: NotRequired["AuthorizationCreateParamsAmountDetails"]
|
||||
"""
|
||||
Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||||
"""
|
||||
authorization_method: NotRequired[
|
||||
Literal["chip", "contactless", "keyed_in", "online", "swipe"]
|
||||
]
|
||||
"""
|
||||
How the card details were provided. Defaults to online.
|
||||
"""
|
||||
card: str
|
||||
"""
|
||||
Card associated with this authorization.
|
||||
"""
|
||||
currency: NotRequired[str]
|
||||
"""
|
||||
The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
fleet: NotRequired["AuthorizationCreateParamsFleet"]
|
||||
"""
|
||||
Fleet-specific information for authorizations using Fleet cards.
|
||||
"""
|
||||
fraud_disputability_likelihood: NotRequired[
|
||||
Literal["neutral", "unknown", "very_likely", "very_unlikely"]
|
||||
]
|
||||
"""
|
||||
Probability that this transaction can be disputed in the event of fraud. Assessed by comparing the characteristics of the authorization to card network rules.
|
||||
"""
|
||||
fuel: NotRequired["AuthorizationCreateParamsFuel"]
|
||||
"""
|
||||
Information about fuel that was purchased with this transaction.
|
||||
"""
|
||||
is_amount_controllable: NotRequired[bool]
|
||||
"""
|
||||
If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
|
||||
"""
|
||||
merchant_amount: NotRequired[int]
|
||||
"""
|
||||
The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||||
"""
|
||||
merchant_currency: NotRequired[str]
|
||||
"""
|
||||
The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
||||
"""
|
||||
merchant_data: NotRequired["AuthorizationCreateParamsMerchantData"]
|
||||
"""
|
||||
Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
|
||||
"""
|
||||
network_data: NotRequired["AuthorizationCreateParamsNetworkData"]
|
||||
"""
|
||||
Details about the authorization, such as identifiers, set by the card network.
|
||||
"""
|
||||
risk_assessment: NotRequired["AuthorizationCreateParamsRiskAssessment"]
|
||||
"""
|
||||
Stripe's assessment of the fraud risk for this authorization.
|
||||
"""
|
||||
verification_data: NotRequired["AuthorizationCreateParamsVerificationData"]
|
||||
"""
|
||||
Verifications that Stripe performed on information that the cardholder provided to the merchant.
|
||||
"""
|
||||
wallet: NotRequired[Literal["apple_pay", "google_pay", "samsung_pay"]]
|
||||
"""
|
||||
The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsAmountDetails(TypedDict):
|
||||
atm_fee: NotRequired[int]
|
||||
"""
|
||||
The ATM withdrawal fee.
|
||||
"""
|
||||
cashback_amount: NotRequired[int]
|
||||
"""
|
||||
The amount of cash requested by the cardholder.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsFleet(TypedDict):
|
||||
cardholder_prompt_data: NotRequired[
|
||||
"AuthorizationCreateParamsFleetCardholderPromptData"
|
||||
]
|
||||
"""
|
||||
Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
|
||||
"""
|
||||
purchase_type: NotRequired[
|
||||
Literal[
|
||||
"fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase"
|
||||
]
|
||||
]
|
||||
"""
|
||||
The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
|
||||
"""
|
||||
reported_breakdown: NotRequired[
|
||||
"AuthorizationCreateParamsFleetReportedBreakdown"
|
||||
]
|
||||
"""
|
||||
More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
|
||||
"""
|
||||
service_type: NotRequired[
|
||||
Literal["full_service", "non_fuel_transaction", "self_service"]
|
||||
]
|
||||
"""
|
||||
The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsFleetCardholderPromptData(TypedDict):
|
||||
driver_id: NotRequired[str]
|
||||
"""
|
||||
Driver ID.
|
||||
"""
|
||||
odometer: NotRequired[int]
|
||||
"""
|
||||
Odometer reading.
|
||||
"""
|
||||
unspecified_id: NotRequired[str]
|
||||
"""
|
||||
An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
|
||||
"""
|
||||
user_id: NotRequired[str]
|
||||
"""
|
||||
User ID.
|
||||
"""
|
||||
vehicle_number: NotRequired[str]
|
||||
"""
|
||||
Vehicle number.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsFleetReportedBreakdown(TypedDict):
|
||||
fuel: NotRequired["AuthorizationCreateParamsFleetReportedBreakdownFuel"]
|
||||
"""
|
||||
Breakdown of fuel portion of the purchase.
|
||||
"""
|
||||
non_fuel: NotRequired[
|
||||
"AuthorizationCreateParamsFleetReportedBreakdownNonFuel"
|
||||
]
|
||||
"""
|
||||
Breakdown of non-fuel portion of the purchase.
|
||||
"""
|
||||
tax: NotRequired["AuthorizationCreateParamsFleetReportedBreakdownTax"]
|
||||
"""
|
||||
Information about tax included in this transaction.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsFleetReportedBreakdownFuel(TypedDict):
|
||||
gross_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsFleetReportedBreakdownNonFuel(TypedDict):
|
||||
gross_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsFleetReportedBreakdownTax(TypedDict):
|
||||
local_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
|
||||
"""
|
||||
national_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsFuel(TypedDict):
|
||||
industry_product_code: NotRequired[str]
|
||||
"""
|
||||
[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
|
||||
"""
|
||||
quantity_decimal: NotRequired[str]
|
||||
"""
|
||||
The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
|
||||
"""
|
||||
type: NotRequired[
|
||||
Literal[
|
||||
"diesel",
|
||||
"other",
|
||||
"unleaded_plus",
|
||||
"unleaded_regular",
|
||||
"unleaded_super",
|
||||
]
|
||||
]
|
||||
"""
|
||||
The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
|
||||
"""
|
||||
unit: NotRequired[
|
||||
Literal[
|
||||
"charging_minute",
|
||||
"imperial_gallon",
|
||||
"kilogram",
|
||||
"kilowatt_hour",
|
||||
"liter",
|
||||
"other",
|
||||
"pound",
|
||||
"us_gallon",
|
||||
]
|
||||
]
|
||||
"""
|
||||
The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
|
||||
"""
|
||||
unit_cost_decimal: NotRequired[str]
|
||||
"""
|
||||
The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsMerchantData(TypedDict):
|
||||
category: NotRequired[
|
||||
Literal[
|
||||
"ac_refrigeration_repair",
|
||||
"accounting_bookkeeping_services",
|
||||
"advertising_services",
|
||||
"agricultural_cooperative",
|
||||
"airlines_air_carriers",
|
||||
"airports_flying_fields",
|
||||
"ambulance_services",
|
||||
"amusement_parks_carnivals",
|
||||
"antique_reproductions",
|
||||
"antique_shops",
|
||||
"aquariums",
|
||||
"architectural_surveying_services",
|
||||
"art_dealers_and_galleries",
|
||||
"artists_supply_and_craft_shops",
|
||||
"auto_and_home_supply_stores",
|
||||
"auto_body_repair_shops",
|
||||
"auto_paint_shops",
|
||||
"auto_service_shops",
|
||||
"automated_cash_disburse",
|
||||
"automated_fuel_dispensers",
|
||||
"automobile_associations",
|
||||
"automotive_parts_and_accessories_stores",
|
||||
"automotive_tire_stores",
|
||||
"bail_and_bond_payments",
|
||||
"bakeries",
|
||||
"bands_orchestras",
|
||||
"barber_and_beauty_shops",
|
||||
"betting_casino_gambling",
|
||||
"bicycle_shops",
|
||||
"billiard_pool_establishments",
|
||||
"boat_dealers",
|
||||
"boat_rentals_and_leases",
|
||||
"book_stores",
|
||||
"books_periodicals_and_newspapers",
|
||||
"bowling_alleys",
|
||||
"bus_lines",
|
||||
"business_secretarial_schools",
|
||||
"buying_shopping_services",
|
||||
"cable_satellite_and_other_pay_television_and_radio",
|
||||
"camera_and_photographic_supply_stores",
|
||||
"candy_nut_and_confectionery_stores",
|
||||
"car_and_truck_dealers_new_used",
|
||||
"car_and_truck_dealers_used_only",
|
||||
"car_rental_agencies",
|
||||
"car_washes",
|
||||
"carpentry_services",
|
||||
"carpet_upholstery_cleaning",
|
||||
"caterers",
|
||||
"charitable_and_social_service_organizations_fundraising",
|
||||
"chemicals_and_allied_products",
|
||||
"child_care_services",
|
||||
"childrens_and_infants_wear_stores",
|
||||
"chiropodists_podiatrists",
|
||||
"chiropractors",
|
||||
"cigar_stores_and_stands",
|
||||
"civic_social_fraternal_associations",
|
||||
"cleaning_and_maintenance",
|
||||
"clothing_rental",
|
||||
"colleges_universities",
|
||||
"commercial_equipment",
|
||||
"commercial_footwear",
|
||||
"commercial_photography_art_and_graphics",
|
||||
"commuter_transport_and_ferries",
|
||||
"computer_network_services",
|
||||
"computer_programming",
|
||||
"computer_repair",
|
||||
"computer_software_stores",
|
||||
"computers_peripherals_and_software",
|
||||
"concrete_work_services",
|
||||
"construction_materials",
|
||||
"consulting_public_relations",
|
||||
"correspondence_schools",
|
||||
"cosmetic_stores",
|
||||
"counseling_services",
|
||||
"country_clubs",
|
||||
"courier_services",
|
||||
"court_costs",
|
||||
"credit_reporting_agencies",
|
||||
"cruise_lines",
|
||||
"dairy_products_stores",
|
||||
"dance_hall_studios_schools",
|
||||
"dating_escort_services",
|
||||
"dentists_orthodontists",
|
||||
"department_stores",
|
||||
"detective_agencies",
|
||||
"digital_goods_applications",
|
||||
"digital_goods_games",
|
||||
"digital_goods_large_volume",
|
||||
"digital_goods_media",
|
||||
"direct_marketing_catalog_merchant",
|
||||
"direct_marketing_combination_catalog_and_retail_merchant",
|
||||
"direct_marketing_inbound_telemarketing",
|
||||
"direct_marketing_insurance_services",
|
||||
"direct_marketing_other",
|
||||
"direct_marketing_outbound_telemarketing",
|
||||
"direct_marketing_subscription",
|
||||
"direct_marketing_travel",
|
||||
"discount_stores",
|
||||
"doctors",
|
||||
"door_to_door_sales",
|
||||
"drapery_window_covering_and_upholstery_stores",
|
||||
"drinking_places",
|
||||
"drug_stores_and_pharmacies",
|
||||
"drugs_drug_proprietaries_and_druggist_sundries",
|
||||
"dry_cleaners",
|
||||
"durable_goods",
|
||||
"duty_free_stores",
|
||||
"eating_places_restaurants",
|
||||
"educational_services",
|
||||
"electric_razor_stores",
|
||||
"electric_vehicle_charging",
|
||||
"electrical_parts_and_equipment",
|
||||
"electrical_services",
|
||||
"electronics_repair_shops",
|
||||
"electronics_stores",
|
||||
"elementary_secondary_schools",
|
||||
"emergency_services_gcas_visa_use_only",
|
||||
"employment_temp_agencies",
|
||||
"equipment_rental",
|
||||
"exterminating_services",
|
||||
"family_clothing_stores",
|
||||
"fast_food_restaurants",
|
||||
"financial_institutions",
|
||||
"fines_government_administrative_entities",
|
||||
"fireplace_fireplace_screens_and_accessories_stores",
|
||||
"floor_covering_stores",
|
||||
"florists",
|
||||
"florists_supplies_nursery_stock_and_flowers",
|
||||
"freezer_and_locker_meat_provisioners",
|
||||
"fuel_dealers_non_automotive",
|
||||
"funeral_services_crematories",
|
||||
"furniture_home_furnishings_and_equipment_stores_except_appliances",
|
||||
"furniture_repair_refinishing",
|
||||
"furriers_and_fur_shops",
|
||||
"general_services",
|
||||
"gift_card_novelty_and_souvenir_shops",
|
||||
"glass_paint_and_wallpaper_stores",
|
||||
"glassware_crystal_stores",
|
||||
"golf_courses_public",
|
||||
"government_licensed_horse_dog_racing_us_region_only",
|
||||
"government_licensed_online_casions_online_gambling_us_region_only",
|
||||
"government_owned_lotteries_non_us_region",
|
||||
"government_owned_lotteries_us_region_only",
|
||||
"government_services",
|
||||
"grocery_stores_supermarkets",
|
||||
"hardware_equipment_and_supplies",
|
||||
"hardware_stores",
|
||||
"health_and_beauty_spas",
|
||||
"hearing_aids_sales_and_supplies",
|
||||
"heating_plumbing_a_c",
|
||||
"hobby_toy_and_game_shops",
|
||||
"home_supply_warehouse_stores",
|
||||
"hospitals",
|
||||
"hotels_motels_and_resorts",
|
||||
"household_appliance_stores",
|
||||
"industrial_supplies",
|
||||
"information_retrieval_services",
|
||||
"insurance_default",
|
||||
"insurance_underwriting_premiums",
|
||||
"intra_company_purchases",
|
||||
"jewelry_stores_watches_clocks_and_silverware_stores",
|
||||
"landscaping_services",
|
||||
"laundries",
|
||||
"laundry_cleaning_services",
|
||||
"legal_services_attorneys",
|
||||
"luggage_and_leather_goods_stores",
|
||||
"lumber_building_materials_stores",
|
||||
"manual_cash_disburse",
|
||||
"marinas_service_and_supplies",
|
||||
"marketplaces",
|
||||
"masonry_stonework_and_plaster",
|
||||
"massage_parlors",
|
||||
"medical_and_dental_labs",
|
||||
"medical_dental_ophthalmic_and_hospital_equipment_and_supplies",
|
||||
"medical_services",
|
||||
"membership_organizations",
|
||||
"mens_and_boys_clothing_and_accessories_stores",
|
||||
"mens_womens_clothing_stores",
|
||||
"metal_service_centers",
|
||||
"miscellaneous_apparel_and_accessory_shops",
|
||||
"miscellaneous_auto_dealers",
|
||||
"miscellaneous_business_services",
|
||||
"miscellaneous_food_stores",
|
||||
"miscellaneous_general_merchandise",
|
||||
"miscellaneous_general_services",
|
||||
"miscellaneous_home_furnishing_specialty_stores",
|
||||
"miscellaneous_publishing_and_printing",
|
||||
"miscellaneous_recreation_services",
|
||||
"miscellaneous_repair_shops",
|
||||
"miscellaneous_specialty_retail",
|
||||
"mobile_home_dealers",
|
||||
"motion_picture_theaters",
|
||||
"motor_freight_carriers_and_trucking",
|
||||
"motor_homes_dealers",
|
||||
"motor_vehicle_supplies_and_new_parts",
|
||||
"motorcycle_shops_and_dealers",
|
||||
"motorcycle_shops_dealers",
|
||||
"music_stores_musical_instruments_pianos_and_sheet_music",
|
||||
"news_dealers_and_newsstands",
|
||||
"non_fi_money_orders",
|
||||
"non_fi_stored_value_card_purchase_load",
|
||||
"nondurable_goods",
|
||||
"nurseries_lawn_and_garden_supply_stores",
|
||||
"nursing_personal_care",
|
||||
"office_and_commercial_furniture",
|
||||
"opticians_eyeglasses",
|
||||
"optometrists_ophthalmologist",
|
||||
"orthopedic_goods_prosthetic_devices",
|
||||
"osteopaths",
|
||||
"package_stores_beer_wine_and_liquor",
|
||||
"paints_varnishes_and_supplies",
|
||||
"parking_lots_garages",
|
||||
"passenger_railways",
|
||||
"pawn_shops",
|
||||
"pet_shops_pet_food_and_supplies",
|
||||
"petroleum_and_petroleum_products",
|
||||
"photo_developing",
|
||||
"photographic_photocopy_microfilm_equipment_and_supplies",
|
||||
"photographic_studios",
|
||||
"picture_video_production",
|
||||
"piece_goods_notions_and_other_dry_goods",
|
||||
"plumbing_heating_equipment_and_supplies",
|
||||
"political_organizations",
|
||||
"postal_services_government_only",
|
||||
"precious_stones_and_metals_watches_and_jewelry",
|
||||
"professional_services",
|
||||
"public_warehousing_and_storage",
|
||||
"quick_copy_repro_and_blueprint",
|
||||
"railroads",
|
||||
"real_estate_agents_and_managers_rentals",
|
||||
"record_stores",
|
||||
"recreational_vehicle_rentals",
|
||||
"religious_goods_stores",
|
||||
"religious_organizations",
|
||||
"roofing_siding_sheet_metal",
|
||||
"secretarial_support_services",
|
||||
"security_brokers_dealers",
|
||||
"service_stations",
|
||||
"sewing_needlework_fabric_and_piece_goods_stores",
|
||||
"shoe_repair_hat_cleaning",
|
||||
"shoe_stores",
|
||||
"small_appliance_repair",
|
||||
"snowmobile_dealers",
|
||||
"special_trade_services",
|
||||
"specialty_cleaning",
|
||||
"sporting_goods_stores",
|
||||
"sporting_recreation_camps",
|
||||
"sports_and_riding_apparel_stores",
|
||||
"sports_clubs_fields",
|
||||
"stamp_and_coin_stores",
|
||||
"stationary_office_supplies_printing_and_writing_paper",
|
||||
"stationery_stores_office_and_school_supply_stores",
|
||||
"swimming_pools_sales",
|
||||
"t_ui_travel_germany",
|
||||
"tailors_alterations",
|
||||
"tax_payments_government_agencies",
|
||||
"tax_preparation_services",
|
||||
"taxicabs_limousines",
|
||||
"telecommunication_equipment_and_telephone_sales",
|
||||
"telecommunication_services",
|
||||
"telegraph_services",
|
||||
"tent_and_awning_shops",
|
||||
"testing_laboratories",
|
||||
"theatrical_ticket_agencies",
|
||||
"timeshares",
|
||||
"tire_retreading_and_repair",
|
||||
"tolls_bridge_fees",
|
||||
"tourist_attractions_and_exhibits",
|
||||
"towing_services",
|
||||
"trailer_parks_campgrounds",
|
||||
"transportation_services",
|
||||
"travel_agencies_tour_operators",
|
||||
"truck_stop_iteration",
|
||||
"truck_utility_trailer_rentals",
|
||||
"typesetting_plate_making_and_related_services",
|
||||
"typewriter_stores",
|
||||
"u_s_federal_government_agencies_or_departments",
|
||||
"uniforms_commercial_clothing",
|
||||
"used_merchandise_and_secondhand_stores",
|
||||
"utilities",
|
||||
"variety_stores",
|
||||
"veterinary_services",
|
||||
"video_amusement_game_supplies",
|
||||
"video_game_arcades",
|
||||
"video_tape_rental_stores",
|
||||
"vocational_trade_schools",
|
||||
"watch_jewelry_repair",
|
||||
"welding_repair",
|
||||
"wholesale_clubs",
|
||||
"wig_and_toupee_stores",
|
||||
"wires_money_orders",
|
||||
"womens_accessory_and_specialty_shops",
|
||||
"womens_ready_to_wear_stores",
|
||||
"wrecking_and_salvage_yards",
|
||||
]
|
||||
]
|
||||
"""
|
||||
A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
|
||||
"""
|
||||
city: NotRequired[str]
|
||||
"""
|
||||
City where the seller is located
|
||||
"""
|
||||
country: NotRequired[str]
|
||||
"""
|
||||
Country where the seller is located
|
||||
"""
|
||||
name: NotRequired[str]
|
||||
"""
|
||||
Name of the seller
|
||||
"""
|
||||
network_id: NotRequired[str]
|
||||
"""
|
||||
Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
|
||||
"""
|
||||
postal_code: NotRequired[str]
|
||||
"""
|
||||
Postal code where the seller is located
|
||||
"""
|
||||
state: NotRequired[str]
|
||||
"""
|
||||
State where the seller is located
|
||||
"""
|
||||
terminal_id: NotRequired[str]
|
||||
"""
|
||||
An ID assigned by the seller to the location of the sale.
|
||||
"""
|
||||
url: NotRequired[str]
|
||||
"""
|
||||
URL provided by the merchant on a 3DS request
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsNetworkData(TypedDict):
|
||||
acquiring_institution_id: NotRequired[str]
|
||||
"""
|
||||
Identifier assigned to the acquirer by the card network.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsRiskAssessment(TypedDict):
|
||||
card_testing_risk: NotRequired[
|
||||
"AuthorizationCreateParamsRiskAssessmentCardTestingRisk"
|
||||
]
|
||||
"""
|
||||
Stripe's assessment of this authorization's likelihood of being card testing activity.
|
||||
"""
|
||||
merchant_dispute_risk: NotRequired[
|
||||
"AuthorizationCreateParamsRiskAssessmentMerchantDisputeRisk"
|
||||
]
|
||||
"""
|
||||
The dispute risk of the merchant (the seller on a purchase) on an authorization based on all Stripe Issuing activity.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsRiskAssessmentCardTestingRisk(TypedDict):
|
||||
invalid_account_number_decline_rate_past_hour: NotRequired[int]
|
||||
"""
|
||||
The % of declines due to a card number not existing in the past hour, taking place at the same merchant. Higher rates correspond to a greater probability of card testing activity, meaning bad actors may be attempting different card number combinations to guess a correct one. Takes on values between 0 and 100.
|
||||
"""
|
||||
invalid_credentials_decline_rate_past_hour: NotRequired[int]
|
||||
"""
|
||||
The % of declines due to incorrect verification data (like CVV or expiry) in the past hour, taking place at the same merchant. Higher rates correspond to a greater probability of bad actors attempting to utilize valid card credentials at merchants with verification requirements. Takes on values between 0 and 100.
|
||||
"""
|
||||
risk_level: Literal[
|
||||
"elevated", "highest", "low", "normal", "not_assessed", "unknown"
|
||||
]
|
||||
"""
|
||||
The likelihood that this authorization is associated with card testing activity. This is assessed by evaluating decline activity over the last hour.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsRiskAssessmentMerchantDisputeRisk(TypedDict):
|
||||
dispute_rate: NotRequired[int]
|
||||
"""
|
||||
The dispute rate observed across all Stripe Issuing authorizations for this merchant. For example, a value of 50 means 50% of authorizations from this merchant on Stripe Issuing have resulted in a dispute. Higher values mean a higher likelihood the authorization is disputed. Takes on values between 0 and 100.
|
||||
"""
|
||||
risk_level: Literal[
|
||||
"elevated", "highest", "low", "normal", "not_assessed", "unknown"
|
||||
]
|
||||
"""
|
||||
The likelihood that authorizations from this merchant will result in a dispute based on their history on Stripe Issuing.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsVerificationData(TypedDict):
|
||||
address_line1_check: NotRequired[
|
||||
Literal["match", "mismatch", "not_provided"]
|
||||
]
|
||||
"""
|
||||
Whether the cardholder provided an address first line and if it matched the cardholder's `billing.address.line1`.
|
||||
"""
|
||||
address_postal_code_check: NotRequired[
|
||||
Literal["match", "mismatch", "not_provided"]
|
||||
]
|
||||
"""
|
||||
Whether the cardholder provided a postal code and if it matched the cardholder's `billing.address.postal_code`.
|
||||
"""
|
||||
authentication_exemption: NotRequired[
|
||||
"AuthorizationCreateParamsVerificationDataAuthenticationExemption"
|
||||
]
|
||||
"""
|
||||
The exemption applied to this authorization.
|
||||
"""
|
||||
cvc_check: NotRequired[Literal["match", "mismatch", "not_provided"]]
|
||||
"""
|
||||
Whether the cardholder provided a CVC and if it matched Stripe's record.
|
||||
"""
|
||||
expiry_check: NotRequired[Literal["match", "mismatch", "not_provided"]]
|
||||
"""
|
||||
Whether the cardholder provided an expiry date and if it matched Stripe's record.
|
||||
"""
|
||||
three_d_secure: NotRequired[
|
||||
"AuthorizationCreateParamsVerificationDataThreeDSecure"
|
||||
]
|
||||
"""
|
||||
3D Secure details.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsVerificationDataAuthenticationExemption(
|
||||
TypedDict,
|
||||
):
|
||||
claimed_by: Literal["acquirer", "issuer"]
|
||||
"""
|
||||
The entity that requested the exemption, either the acquiring merchant or the Issuing user.
|
||||
"""
|
||||
type: Literal[
|
||||
"low_value_transaction", "transaction_risk_analysis", "unknown"
|
||||
]
|
||||
"""
|
||||
The specific exemption claimed for this authorization.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationCreateParamsVerificationDataThreeDSecure(TypedDict):
|
||||
result: Literal[
|
||||
"attempt_acknowledged", "authenticated", "failed", "required"
|
||||
]
|
||||
"""
|
||||
The outcome of the 3D Secure authentication request.
|
||||
"""
|
||||
@@ -0,0 +1,16 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired
|
||||
|
||||
|
||||
class AuthorizationDeclineParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
metadata: NotRequired["Literal['']|Dict[str, str]"]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class AuthorizationExpireParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,166 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class AuthorizationFinalizeAmountParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
final_amount: int
|
||||
"""
|
||||
The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||||
"""
|
||||
fleet: NotRequired["AuthorizationFinalizeAmountParamsFleet"]
|
||||
"""
|
||||
Fleet-specific information for authorizations using Fleet cards.
|
||||
"""
|
||||
fuel: NotRequired["AuthorizationFinalizeAmountParamsFuel"]
|
||||
"""
|
||||
Information about fuel that was purchased with this transaction.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationFinalizeAmountParamsFleet(TypedDict):
|
||||
cardholder_prompt_data: NotRequired[
|
||||
"AuthorizationFinalizeAmountParamsFleetCardholderPromptData"
|
||||
]
|
||||
"""
|
||||
Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.
|
||||
"""
|
||||
purchase_type: NotRequired[
|
||||
Literal[
|
||||
"fuel_and_non_fuel_purchase", "fuel_purchase", "non_fuel_purchase"
|
||||
]
|
||||
]
|
||||
"""
|
||||
The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
|
||||
"""
|
||||
reported_breakdown: NotRequired[
|
||||
"AuthorizationFinalizeAmountParamsFleetReportedBreakdown"
|
||||
]
|
||||
"""
|
||||
More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
|
||||
"""
|
||||
service_type: NotRequired[
|
||||
Literal["full_service", "non_fuel_transaction", "self_service"]
|
||||
]
|
||||
"""
|
||||
The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationFinalizeAmountParamsFleetCardholderPromptData(TypedDict):
|
||||
driver_id: NotRequired[str]
|
||||
"""
|
||||
Driver ID.
|
||||
"""
|
||||
odometer: NotRequired[int]
|
||||
"""
|
||||
Odometer reading.
|
||||
"""
|
||||
unspecified_id: NotRequired[str]
|
||||
"""
|
||||
An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.
|
||||
"""
|
||||
user_id: NotRequired[str]
|
||||
"""
|
||||
User ID.
|
||||
"""
|
||||
vehicle_number: NotRequired[str]
|
||||
"""
|
||||
Vehicle number.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationFinalizeAmountParamsFleetReportedBreakdown(TypedDict):
|
||||
fuel: NotRequired[
|
||||
"AuthorizationFinalizeAmountParamsFleetReportedBreakdownFuel"
|
||||
]
|
||||
"""
|
||||
Breakdown of fuel portion of the purchase.
|
||||
"""
|
||||
non_fuel: NotRequired[
|
||||
"AuthorizationFinalizeAmountParamsFleetReportedBreakdownNonFuel"
|
||||
]
|
||||
"""
|
||||
Breakdown of non-fuel portion of the purchase.
|
||||
"""
|
||||
tax: NotRequired[
|
||||
"AuthorizationFinalizeAmountParamsFleetReportedBreakdownTax"
|
||||
]
|
||||
"""
|
||||
Information about tax included in this transaction.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationFinalizeAmountParamsFleetReportedBreakdownFuel(TypedDict):
|
||||
gross_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationFinalizeAmountParamsFleetReportedBreakdownNonFuel(
|
||||
TypedDict
|
||||
):
|
||||
gross_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationFinalizeAmountParamsFleetReportedBreakdownTax(TypedDict):
|
||||
local_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
|
||||
"""
|
||||
national_amount_decimal: NotRequired[str]
|
||||
"""
|
||||
Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationFinalizeAmountParamsFuel(TypedDict):
|
||||
industry_product_code: NotRequired[str]
|
||||
"""
|
||||
[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
|
||||
"""
|
||||
quantity_decimal: NotRequired[str]
|
||||
"""
|
||||
The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
|
||||
"""
|
||||
type: NotRequired[
|
||||
Literal[
|
||||
"diesel",
|
||||
"other",
|
||||
"unleaded_plus",
|
||||
"unleaded_regular",
|
||||
"unleaded_super",
|
||||
]
|
||||
]
|
||||
"""
|
||||
The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
|
||||
"""
|
||||
unit: NotRequired[
|
||||
Literal[
|
||||
"charging_minute",
|
||||
"imperial_gallon",
|
||||
"kilogram",
|
||||
"kilowatt_hour",
|
||||
"liter",
|
||||
"other",
|
||||
"pound",
|
||||
"us_gallon",
|
||||
]
|
||||
]
|
||||
"""
|
||||
The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
|
||||
"""
|
||||
unit_cost_decimal: NotRequired[str]
|
||||
"""
|
||||
The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
|
||||
"""
|
||||
@@ -0,0 +1,20 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class AuthorizationIncrementParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
increment_amount: int
|
||||
"""
|
||||
The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||||
"""
|
||||
is_amount_controllable: NotRequired[bool]
|
||||
"""
|
||||
If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
|
||||
"""
|
||||
@@ -0,0 +1,59 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class AuthorizationListParams(RequestOptions):
|
||||
card: NotRequired[str]
|
||||
"""
|
||||
Only return authorizations that belong to the given card.
|
||||
"""
|
||||
cardholder: NotRequired[str]
|
||||
"""
|
||||
Only return authorizations that belong to the given cardholder.
|
||||
"""
|
||||
created: NotRequired["AuthorizationListParamsCreated|int"]
|
||||
"""
|
||||
Only return authorizations that were created during the given date interval.
|
||||
"""
|
||||
ending_before: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
limit: NotRequired[int]
|
||||
"""
|
||||
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
||||
"""
|
||||
starting_after: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
||||
"""
|
||||
status: NotRequired[Literal["closed", "expired", "pending", "reversed"]]
|
||||
"""
|
||||
Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.
|
||||
"""
|
||||
|
||||
|
||||
class AuthorizationListParamsCreated(TypedDict):
|
||||
gt: NotRequired[int]
|
||||
"""
|
||||
Minimum value to filter by (exclusive)
|
||||
"""
|
||||
gte: NotRequired[int]
|
||||
"""
|
||||
Minimum value to filter by (inclusive)
|
||||
"""
|
||||
lt: NotRequired[int]
|
||||
"""
|
||||
Maximum value to filter by (exclusive)
|
||||
"""
|
||||
lte: NotRequired[int]
|
||||
"""
|
||||
Maximum value to filter by (inclusive)
|
||||
"""
|
||||
@@ -0,0 +1,16 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired
|
||||
|
||||
|
||||
class AuthorizationModifyParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
metadata: NotRequired["Literal['']|Dict[str, str]"]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
@@ -0,0 +1,16 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class AuthorizationRespondParams(RequestOptions):
|
||||
confirmed: bool
|
||||
"""
|
||||
Whether to simulate the user confirming that the transaction was legitimate (true) or telling Stripe that it was fraudulent (false).
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class AuthorizationRetrieveParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,16 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class AuthorizationReverseParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
reverse_amount: NotRequired[int]
|
||||
"""
|
||||
The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||||
"""
|
||||
@@ -0,0 +1,15 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class AuthorizationUpdateParams(TypedDict):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
metadata: NotRequired["Literal['']|Dict[str, str]"]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class CardDeliverCardParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class CardFailCardParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,72 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class CardListParams(RequestOptions):
|
||||
cardholder: NotRequired[str]
|
||||
"""
|
||||
Only return cards belonging to the Cardholder with the provided ID.
|
||||
"""
|
||||
created: NotRequired["CardListParamsCreated|int"]
|
||||
"""
|
||||
Only return cards that were issued during the given date interval.
|
||||
"""
|
||||
ending_before: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
||||
"""
|
||||
exp_month: NotRequired[int]
|
||||
"""
|
||||
Only return cards that have the given expiration month.
|
||||
"""
|
||||
exp_year: NotRequired[int]
|
||||
"""
|
||||
Only return cards that have the given expiration year.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
last4: NotRequired[str]
|
||||
"""
|
||||
Only return cards that have the given last four digits.
|
||||
"""
|
||||
limit: NotRequired[int]
|
||||
"""
|
||||
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
||||
"""
|
||||
personalization_design: NotRequired[str]
|
||||
starting_after: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
||||
"""
|
||||
status: NotRequired[Literal["active", "canceled", "inactive"]]
|
||||
"""
|
||||
Only return cards that have the given status. One of `active`, `inactive`, or `canceled`.
|
||||
"""
|
||||
type: NotRequired[Literal["physical", "virtual"]]
|
||||
"""
|
||||
Only return cards that have the given type. One of `virtual` or `physical`.
|
||||
"""
|
||||
|
||||
|
||||
class CardListParamsCreated(TypedDict):
|
||||
gt: NotRequired[int]
|
||||
"""
|
||||
Minimum value to filter by (exclusive)
|
||||
"""
|
||||
gte: NotRequired[int]
|
||||
"""
|
||||
Minimum value to filter by (inclusive)
|
||||
"""
|
||||
lt: NotRequired[int]
|
||||
"""
|
||||
Maximum value to filter by (exclusive)
|
||||
"""
|
||||
lte: NotRequired[int]
|
||||
"""
|
||||
Maximum value to filter by (inclusive)
|
||||
"""
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class CardRetrieveParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class CardReturnCardParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class CardShipCardParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class CardSubmitCardParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,63 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class CardholderListParams(RequestOptions):
|
||||
created: NotRequired["CardholderListParamsCreated|int"]
|
||||
"""
|
||||
Only return cardholders that were created during the given date interval.
|
||||
"""
|
||||
email: NotRequired[str]
|
||||
"""
|
||||
Only return cardholders that have the given email address.
|
||||
"""
|
||||
ending_before: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
limit: NotRequired[int]
|
||||
"""
|
||||
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
||||
"""
|
||||
phone_number: NotRequired[str]
|
||||
"""
|
||||
Only return cardholders that have the given phone number.
|
||||
"""
|
||||
starting_after: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
||||
"""
|
||||
status: NotRequired[Literal["active", "blocked", "inactive"]]
|
||||
"""
|
||||
Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.
|
||||
"""
|
||||
type: NotRequired[Literal["company", "individual"]]
|
||||
"""
|
||||
Only return cardholders that have the given type. One of `individual` or `company`.
|
||||
"""
|
||||
|
||||
|
||||
class CardholderListParamsCreated(TypedDict):
|
||||
gt: NotRequired[int]
|
||||
"""
|
||||
Minimum value to filter by (exclusive)
|
||||
"""
|
||||
gte: NotRequired[int]
|
||||
"""
|
||||
Minimum value to filter by (inclusive)
|
||||
"""
|
||||
lt: NotRequired[int]
|
||||
"""
|
||||
Maximum value to filter by (exclusive)
|
||||
"""
|
||||
lte: NotRequired[int]
|
||||
"""
|
||||
Maximum value to filter by (inclusive)
|
||||
"""
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class CardholderRetrieveParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,287 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class DisputeCreateParams(RequestOptions):
|
||||
amount: NotRequired[int]
|
||||
"""
|
||||
The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount.
|
||||
"""
|
||||
evidence: NotRequired["DisputeCreateParamsEvidence"]
|
||||
"""
|
||||
Evidence provided for the dispute.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
metadata: NotRequired[Dict[str, str]]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
transaction: NotRequired[str]
|
||||
"""
|
||||
The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.
|
||||
"""
|
||||
treasury: NotRequired["DisputeCreateParamsTreasury"]
|
||||
"""
|
||||
Params for disputes related to Treasury FinancialAccounts
|
||||
"""
|
||||
|
||||
|
||||
class DisputeCreateParamsEvidence(TypedDict):
|
||||
canceled: NotRequired["Literal['']|DisputeCreateParamsEvidenceCanceled"]
|
||||
"""
|
||||
Evidence provided when `reason` is 'canceled'.
|
||||
"""
|
||||
duplicate: NotRequired["Literal['']|DisputeCreateParamsEvidenceDuplicate"]
|
||||
"""
|
||||
Evidence provided when `reason` is 'duplicate'.
|
||||
"""
|
||||
fraudulent: NotRequired[
|
||||
"Literal['']|DisputeCreateParamsEvidenceFraudulent"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'fraudulent'.
|
||||
"""
|
||||
merchandise_not_as_described: NotRequired[
|
||||
"Literal['']|DisputeCreateParamsEvidenceMerchandiseNotAsDescribed"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'merchandise_not_as_described'.
|
||||
"""
|
||||
no_valid_authorization: NotRequired[
|
||||
"Literal['']|DisputeCreateParamsEvidenceNoValidAuthorization"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'no_valid_authorization'.
|
||||
"""
|
||||
not_received: NotRequired[
|
||||
"Literal['']|DisputeCreateParamsEvidenceNotReceived"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'not_received'.
|
||||
"""
|
||||
other: NotRequired["Literal['']|DisputeCreateParamsEvidenceOther"]
|
||||
"""
|
||||
Evidence provided when `reason` is 'other'.
|
||||
"""
|
||||
reason: NotRequired[
|
||||
Literal[
|
||||
"canceled",
|
||||
"duplicate",
|
||||
"fraudulent",
|
||||
"merchandise_not_as_described",
|
||||
"no_valid_authorization",
|
||||
"not_received",
|
||||
"other",
|
||||
"service_not_as_described",
|
||||
]
|
||||
]
|
||||
"""
|
||||
The reason for filing the dispute. The evidence should be submitted in the field of the same name.
|
||||
"""
|
||||
service_not_as_described: NotRequired[
|
||||
"Literal['']|DisputeCreateParamsEvidenceServiceNotAsDescribed"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'service_not_as_described'.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeCreateParamsEvidenceCanceled(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
canceled_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when order was canceled.
|
||||
"""
|
||||
cancellation_policy_provided: NotRequired["Literal['']|bool"]
|
||||
"""
|
||||
Whether the cardholder was provided with a cancellation policy.
|
||||
"""
|
||||
cancellation_reason: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Reason for canceling the order.
|
||||
"""
|
||||
expected_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the cardholder expected to receive the product.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
product_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the merchandise or service that was purchased.
|
||||
"""
|
||||
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
|
||||
"""
|
||||
Whether the product was a merchandise or service.
|
||||
"""
|
||||
return_status: NotRequired[
|
||||
"Literal['']|Literal['merchant_rejected', 'successful']"
|
||||
]
|
||||
"""
|
||||
Result of cardholder's attempt to return the product.
|
||||
"""
|
||||
returned_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was returned or attempted to be returned.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeCreateParamsEvidenceDuplicate(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
card_statement: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
|
||||
"""
|
||||
cash_receipt: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
|
||||
"""
|
||||
check_image: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
original_transaction: NotRequired[str]
|
||||
"""
|
||||
Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeCreateParamsEvidenceFraudulent(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeCreateParamsEvidenceMerchandiseNotAsDescribed(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
received_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was received.
|
||||
"""
|
||||
return_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the cardholder's attempt to return the product.
|
||||
"""
|
||||
return_status: NotRequired[
|
||||
"Literal['']|Literal['merchant_rejected', 'successful']"
|
||||
]
|
||||
"""
|
||||
Result of cardholder's attempt to return the product.
|
||||
"""
|
||||
returned_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was returned or attempted to be returned.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeCreateParamsEvidenceNoValidAuthorization(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeCreateParamsEvidenceNotReceived(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
expected_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the cardholder expected to receive the product.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
product_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the merchandise or service that was purchased.
|
||||
"""
|
||||
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
|
||||
"""
|
||||
Whether the product was a merchandise or service.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeCreateParamsEvidenceOther(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
product_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the merchandise or service that was purchased.
|
||||
"""
|
||||
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
|
||||
"""
|
||||
Whether the product was a merchandise or service.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeCreateParamsEvidenceServiceNotAsDescribed(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
canceled_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when order was canceled.
|
||||
"""
|
||||
cancellation_reason: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Reason for canceling the order.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
received_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was received.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeCreateParamsTreasury(TypedDict):
|
||||
received_debit: str
|
||||
"""
|
||||
The ID of the ReceivedDebit to initiate an Issuings dispute for.
|
||||
"""
|
||||
@@ -0,0 +1,57 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class DisputeListParams(RequestOptions):
|
||||
created: NotRequired["DisputeListParamsCreated|int"]
|
||||
"""
|
||||
Only return Issuing disputes that were created during the given date interval.
|
||||
"""
|
||||
ending_before: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
limit: NotRequired[int]
|
||||
"""
|
||||
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
||||
"""
|
||||
starting_after: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
||||
"""
|
||||
status: NotRequired[
|
||||
Literal["expired", "lost", "submitted", "unsubmitted", "won"]
|
||||
]
|
||||
"""
|
||||
Select Issuing disputes with the given status.
|
||||
"""
|
||||
transaction: NotRequired[str]
|
||||
"""
|
||||
Select the Issuing dispute for the given transaction.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeListParamsCreated(TypedDict):
|
||||
gt: NotRequired[int]
|
||||
"""
|
||||
Minimum value to filter by (exclusive)
|
||||
"""
|
||||
gte: NotRequired[int]
|
||||
"""
|
||||
Minimum value to filter by (inclusive)
|
||||
"""
|
||||
lt: NotRequired[int]
|
||||
"""
|
||||
Maximum value to filter by (exclusive)
|
||||
"""
|
||||
lte: NotRequired[int]
|
||||
"""
|
||||
Maximum value to filter by (inclusive)
|
||||
"""
|
||||
@@ -0,0 +1,272 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class DisputeModifyParams(RequestOptions):
|
||||
amount: NotRequired[int]
|
||||
"""
|
||||
The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||||
"""
|
||||
evidence: NotRequired["DisputeModifyParamsEvidence"]
|
||||
"""
|
||||
Evidence provided for the dispute.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
metadata: NotRequired["Literal['']|Dict[str, str]"]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeModifyParamsEvidence(TypedDict):
|
||||
canceled: NotRequired["Literal['']|DisputeModifyParamsEvidenceCanceled"]
|
||||
"""
|
||||
Evidence provided when `reason` is 'canceled'.
|
||||
"""
|
||||
duplicate: NotRequired["Literal['']|DisputeModifyParamsEvidenceDuplicate"]
|
||||
"""
|
||||
Evidence provided when `reason` is 'duplicate'.
|
||||
"""
|
||||
fraudulent: NotRequired[
|
||||
"Literal['']|DisputeModifyParamsEvidenceFraudulent"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'fraudulent'.
|
||||
"""
|
||||
merchandise_not_as_described: NotRequired[
|
||||
"Literal['']|DisputeModifyParamsEvidenceMerchandiseNotAsDescribed"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'merchandise_not_as_described'.
|
||||
"""
|
||||
no_valid_authorization: NotRequired[
|
||||
"Literal['']|DisputeModifyParamsEvidenceNoValidAuthorization"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'no_valid_authorization'.
|
||||
"""
|
||||
not_received: NotRequired[
|
||||
"Literal['']|DisputeModifyParamsEvidenceNotReceived"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'not_received'.
|
||||
"""
|
||||
other: NotRequired["Literal['']|DisputeModifyParamsEvidenceOther"]
|
||||
"""
|
||||
Evidence provided when `reason` is 'other'.
|
||||
"""
|
||||
reason: NotRequired[
|
||||
Literal[
|
||||
"canceled",
|
||||
"duplicate",
|
||||
"fraudulent",
|
||||
"merchandise_not_as_described",
|
||||
"no_valid_authorization",
|
||||
"not_received",
|
||||
"other",
|
||||
"service_not_as_described",
|
||||
]
|
||||
]
|
||||
"""
|
||||
The reason for filing the dispute. The evidence should be submitted in the field of the same name.
|
||||
"""
|
||||
service_not_as_described: NotRequired[
|
||||
"Literal['']|DisputeModifyParamsEvidenceServiceNotAsDescribed"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'service_not_as_described'.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeModifyParamsEvidenceCanceled(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
canceled_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when order was canceled.
|
||||
"""
|
||||
cancellation_policy_provided: NotRequired["Literal['']|bool"]
|
||||
"""
|
||||
Whether the cardholder was provided with a cancellation policy.
|
||||
"""
|
||||
cancellation_reason: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Reason for canceling the order.
|
||||
"""
|
||||
expected_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the cardholder expected to receive the product.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
product_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the merchandise or service that was purchased.
|
||||
"""
|
||||
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
|
||||
"""
|
||||
Whether the product was a merchandise or service.
|
||||
"""
|
||||
return_status: NotRequired[
|
||||
"Literal['']|Literal['merchant_rejected', 'successful']"
|
||||
]
|
||||
"""
|
||||
Result of cardholder's attempt to return the product.
|
||||
"""
|
||||
returned_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was returned or attempted to be returned.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeModifyParamsEvidenceDuplicate(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
card_statement: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
|
||||
"""
|
||||
cash_receipt: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
|
||||
"""
|
||||
check_image: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
original_transaction: NotRequired[str]
|
||||
"""
|
||||
Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeModifyParamsEvidenceFraudulent(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeModifyParamsEvidenceMerchandiseNotAsDescribed(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
received_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was received.
|
||||
"""
|
||||
return_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the cardholder's attempt to return the product.
|
||||
"""
|
||||
return_status: NotRequired[
|
||||
"Literal['']|Literal['merchant_rejected', 'successful']"
|
||||
]
|
||||
"""
|
||||
Result of cardholder's attempt to return the product.
|
||||
"""
|
||||
returned_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was returned or attempted to be returned.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeModifyParamsEvidenceNoValidAuthorization(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeModifyParamsEvidenceNotReceived(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
expected_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the cardholder expected to receive the product.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
product_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the merchandise or service that was purchased.
|
||||
"""
|
||||
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
|
||||
"""
|
||||
Whether the product was a merchandise or service.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeModifyParamsEvidenceOther(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
product_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the merchandise or service that was purchased.
|
||||
"""
|
||||
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
|
||||
"""
|
||||
Whether the product was a merchandise or service.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeModifyParamsEvidenceServiceNotAsDescribed(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
canceled_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when order was canceled.
|
||||
"""
|
||||
cancellation_reason: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Reason for canceling the order.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
received_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was received.
|
||||
"""
|
||||
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class DisputeRetrieveParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,16 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired
|
||||
|
||||
|
||||
class DisputeSubmitParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
metadata: NotRequired["Literal['']|Dict[str, str]"]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
@@ -0,0 +1,271 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class DisputeUpdateParams(TypedDict):
|
||||
amount: NotRequired[int]
|
||||
"""
|
||||
The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
|
||||
"""
|
||||
evidence: NotRequired["DisputeUpdateParamsEvidence"]
|
||||
"""
|
||||
Evidence provided for the dispute.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
metadata: NotRequired["Literal['']|Dict[str, str]"]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeUpdateParamsEvidence(TypedDict):
|
||||
canceled: NotRequired["Literal['']|DisputeUpdateParamsEvidenceCanceled"]
|
||||
"""
|
||||
Evidence provided when `reason` is 'canceled'.
|
||||
"""
|
||||
duplicate: NotRequired["Literal['']|DisputeUpdateParamsEvidenceDuplicate"]
|
||||
"""
|
||||
Evidence provided when `reason` is 'duplicate'.
|
||||
"""
|
||||
fraudulent: NotRequired[
|
||||
"Literal['']|DisputeUpdateParamsEvidenceFraudulent"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'fraudulent'.
|
||||
"""
|
||||
merchandise_not_as_described: NotRequired[
|
||||
"Literal['']|DisputeUpdateParamsEvidenceMerchandiseNotAsDescribed"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'merchandise_not_as_described'.
|
||||
"""
|
||||
no_valid_authorization: NotRequired[
|
||||
"Literal['']|DisputeUpdateParamsEvidenceNoValidAuthorization"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'no_valid_authorization'.
|
||||
"""
|
||||
not_received: NotRequired[
|
||||
"Literal['']|DisputeUpdateParamsEvidenceNotReceived"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'not_received'.
|
||||
"""
|
||||
other: NotRequired["Literal['']|DisputeUpdateParamsEvidenceOther"]
|
||||
"""
|
||||
Evidence provided when `reason` is 'other'.
|
||||
"""
|
||||
reason: NotRequired[
|
||||
Literal[
|
||||
"canceled",
|
||||
"duplicate",
|
||||
"fraudulent",
|
||||
"merchandise_not_as_described",
|
||||
"no_valid_authorization",
|
||||
"not_received",
|
||||
"other",
|
||||
"service_not_as_described",
|
||||
]
|
||||
]
|
||||
"""
|
||||
The reason for filing the dispute. The evidence should be submitted in the field of the same name.
|
||||
"""
|
||||
service_not_as_described: NotRequired[
|
||||
"Literal['']|DisputeUpdateParamsEvidenceServiceNotAsDescribed"
|
||||
]
|
||||
"""
|
||||
Evidence provided when `reason` is 'service_not_as_described'.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeUpdateParamsEvidenceCanceled(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
canceled_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when order was canceled.
|
||||
"""
|
||||
cancellation_policy_provided: NotRequired["Literal['']|bool"]
|
||||
"""
|
||||
Whether the cardholder was provided with a cancellation policy.
|
||||
"""
|
||||
cancellation_reason: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Reason for canceling the order.
|
||||
"""
|
||||
expected_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the cardholder expected to receive the product.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
product_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the merchandise or service that was purchased.
|
||||
"""
|
||||
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
|
||||
"""
|
||||
Whether the product was a merchandise or service.
|
||||
"""
|
||||
return_status: NotRequired[
|
||||
"Literal['']|Literal['merchant_rejected', 'successful']"
|
||||
]
|
||||
"""
|
||||
Result of cardholder's attempt to return the product.
|
||||
"""
|
||||
returned_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was returned or attempted to be returned.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeUpdateParamsEvidenceDuplicate(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
card_statement: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.
|
||||
"""
|
||||
cash_receipt: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.
|
||||
"""
|
||||
check_image: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
original_transaction: NotRequired[str]
|
||||
"""
|
||||
Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeUpdateParamsEvidenceFraudulent(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeUpdateParamsEvidenceMerchandiseNotAsDescribed(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
received_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was received.
|
||||
"""
|
||||
return_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the cardholder's attempt to return the product.
|
||||
"""
|
||||
return_status: NotRequired[
|
||||
"Literal['']|Literal['merchant_rejected', 'successful']"
|
||||
]
|
||||
"""
|
||||
Result of cardholder's attempt to return the product.
|
||||
"""
|
||||
returned_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was returned or attempted to be returned.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeUpdateParamsEvidenceNoValidAuthorization(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeUpdateParamsEvidenceNotReceived(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
expected_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the cardholder expected to receive the product.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
product_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the merchandise or service that was purchased.
|
||||
"""
|
||||
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
|
||||
"""
|
||||
Whether the product was a merchandise or service.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeUpdateParamsEvidenceOther(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
product_description: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Description of the merchandise or service that was purchased.
|
||||
"""
|
||||
product_type: NotRequired["Literal['']|Literal['merchandise', 'service']"]
|
||||
"""
|
||||
Whether the product was a merchandise or service.
|
||||
"""
|
||||
|
||||
|
||||
class DisputeUpdateParamsEvidenceServiceNotAsDescribed(TypedDict):
|
||||
additional_documentation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.
|
||||
"""
|
||||
canceled_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when order was canceled.
|
||||
"""
|
||||
cancellation_reason: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Reason for canceling the order.
|
||||
"""
|
||||
explanation: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Explanation of why the cardholder is disputing this transaction.
|
||||
"""
|
||||
received_at: NotRequired["Literal['']|int"]
|
||||
"""
|
||||
Date when the product was received.
|
||||
"""
|
||||
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class PersonalizationDesignActivateParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,70 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class PersonalizationDesignCreateParams(RequestOptions):
|
||||
card_logo: NotRequired[str]
|
||||
"""
|
||||
The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
|
||||
"""
|
||||
carrier_text: NotRequired["PersonalizationDesignCreateParamsCarrierText"]
|
||||
"""
|
||||
Hash containing carrier text, for use with physical bundles that support carrier text.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
lookup_key: NotRequired[str]
|
||||
"""
|
||||
A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
|
||||
"""
|
||||
metadata: NotRequired[Dict[str, str]]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
name: NotRequired[str]
|
||||
"""
|
||||
Friendly display name.
|
||||
"""
|
||||
physical_bundle: str
|
||||
"""
|
||||
The physical bundle object belonging to this personalization design.
|
||||
"""
|
||||
preferences: NotRequired["PersonalizationDesignCreateParamsPreferences"]
|
||||
"""
|
||||
Information on whether this personalization design is used to create cards when one is not specified.
|
||||
"""
|
||||
transfer_lookup_key: NotRequired[bool]
|
||||
"""
|
||||
If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
|
||||
"""
|
||||
|
||||
|
||||
class PersonalizationDesignCreateParamsCarrierText(TypedDict):
|
||||
footer_body: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The footer body text of the carrier letter.
|
||||
"""
|
||||
footer_title: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The footer title text of the carrier letter.
|
||||
"""
|
||||
header_body: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The header body text of the carrier letter.
|
||||
"""
|
||||
header_title: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The header title text of the carrier letter.
|
||||
"""
|
||||
|
||||
|
||||
class PersonalizationDesignCreateParamsPreferences(TypedDict):
|
||||
is_default: bool
|
||||
"""
|
||||
Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
|
||||
"""
|
||||
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class PersonalizationDesignDeactivateParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,47 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class PersonalizationDesignListParams(RequestOptions):
|
||||
ending_before: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
limit: NotRequired[int]
|
||||
"""
|
||||
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
||||
"""
|
||||
lookup_keys: NotRequired[List[str]]
|
||||
"""
|
||||
Only return personalization designs with the given lookup keys.
|
||||
"""
|
||||
preferences: NotRequired["PersonalizationDesignListParamsPreferences"]
|
||||
"""
|
||||
Only return personalization designs with the given preferences.
|
||||
"""
|
||||
starting_after: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
||||
"""
|
||||
status: NotRequired[Literal["active", "inactive", "rejected", "review"]]
|
||||
"""
|
||||
Only return personalization designs with the given status.
|
||||
"""
|
||||
|
||||
|
||||
class PersonalizationDesignListParamsPreferences(TypedDict):
|
||||
is_default: NotRequired[bool]
|
||||
"""
|
||||
Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default.
|
||||
"""
|
||||
is_platform_default: NotRequired[bool]
|
||||
"""
|
||||
Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts.
|
||||
"""
|
||||
@@ -0,0 +1,72 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class PersonalizationDesignModifyParams(RequestOptions):
|
||||
card_logo: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
|
||||
"""
|
||||
carrier_text: NotRequired[
|
||||
"Literal['']|PersonalizationDesignModifyParamsCarrierText"
|
||||
]
|
||||
"""
|
||||
Hash containing carrier text, for use with physical bundles that support carrier text.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
lookup_key: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
|
||||
"""
|
||||
metadata: NotRequired[Dict[str, str]]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
name: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Friendly display name. Providing an empty string will set the field to null.
|
||||
"""
|
||||
physical_bundle: NotRequired[str]
|
||||
"""
|
||||
The physical bundle object belonging to this personalization design.
|
||||
"""
|
||||
preferences: NotRequired["PersonalizationDesignModifyParamsPreferences"]
|
||||
"""
|
||||
Information on whether this personalization design is used to create cards when one is not specified.
|
||||
"""
|
||||
transfer_lookup_key: NotRequired[bool]
|
||||
"""
|
||||
If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
|
||||
"""
|
||||
|
||||
|
||||
class PersonalizationDesignModifyParamsCarrierText(TypedDict):
|
||||
footer_body: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The footer body text of the carrier letter.
|
||||
"""
|
||||
footer_title: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The footer title text of the carrier letter.
|
||||
"""
|
||||
header_body: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The header body text of the carrier letter.
|
||||
"""
|
||||
header_title: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The header title text of the carrier letter.
|
||||
"""
|
||||
|
||||
|
||||
class PersonalizationDesignModifyParamsPreferences(TypedDict):
|
||||
is_default: bool
|
||||
"""
|
||||
Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
|
||||
"""
|
||||
@@ -0,0 +1,52 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class PersonalizationDesignRejectParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
rejection_reasons: "PersonalizationDesignRejectParamsRejectionReasons"
|
||||
"""
|
||||
The reason(s) the personalization design was rejected.
|
||||
"""
|
||||
|
||||
|
||||
class PersonalizationDesignRejectParamsRejectionReasons(TypedDict):
|
||||
card_logo: NotRequired[
|
||||
List[
|
||||
Literal[
|
||||
"geographic_location",
|
||||
"inappropriate",
|
||||
"network_name",
|
||||
"non_binary_image",
|
||||
"non_fiat_currency",
|
||||
"other",
|
||||
"other_entity",
|
||||
"promotional_material",
|
||||
]
|
||||
]
|
||||
]
|
||||
"""
|
||||
The reason(s) the card logo was rejected.
|
||||
"""
|
||||
carrier_text: NotRequired[
|
||||
List[
|
||||
Literal[
|
||||
"geographic_location",
|
||||
"inappropriate",
|
||||
"network_name",
|
||||
"non_fiat_currency",
|
||||
"other",
|
||||
"other_entity",
|
||||
"promotional_material",
|
||||
]
|
||||
]
|
||||
]
|
||||
"""
|
||||
The reason(s) the carrier text was rejected.
|
||||
"""
|
||||
@@ -0,0 +1,12 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import NotRequired
|
||||
|
||||
|
||||
class PersonalizationDesignRetrieveParams(RequestOptions):
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
@@ -0,0 +1,71 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from typing import Dict, List
|
||||
from typing_extensions import Literal, NotRequired, TypedDict
|
||||
|
||||
|
||||
class PersonalizationDesignUpdateParams(TypedDict):
|
||||
card_logo: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
|
||||
"""
|
||||
carrier_text: NotRequired[
|
||||
"Literal['']|PersonalizationDesignUpdateParamsCarrierText"
|
||||
]
|
||||
"""
|
||||
Hash containing carrier text, for use with physical bundles that support carrier text.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
lookup_key: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
|
||||
"""
|
||||
metadata: NotRequired[Dict[str, str]]
|
||||
"""
|
||||
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
|
||||
"""
|
||||
name: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
Friendly display name. Providing an empty string will set the field to null.
|
||||
"""
|
||||
physical_bundle: NotRequired[str]
|
||||
"""
|
||||
The physical bundle object belonging to this personalization design.
|
||||
"""
|
||||
preferences: NotRequired["PersonalizationDesignUpdateParamsPreferences"]
|
||||
"""
|
||||
Information on whether this personalization design is used to create cards when one is not specified.
|
||||
"""
|
||||
transfer_lookup_key: NotRequired[bool]
|
||||
"""
|
||||
If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
|
||||
"""
|
||||
|
||||
|
||||
class PersonalizationDesignUpdateParamsCarrierText(TypedDict):
|
||||
footer_body: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The footer body text of the carrier letter.
|
||||
"""
|
||||
footer_title: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The footer title text of the carrier letter.
|
||||
"""
|
||||
header_body: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The header body text of the carrier letter.
|
||||
"""
|
||||
header_title: NotRequired["Literal['']|str"]
|
||||
"""
|
||||
The header title text of the carrier letter.
|
||||
"""
|
||||
|
||||
|
||||
class PersonalizationDesignUpdateParamsPreferences(TypedDict):
|
||||
is_default: bool
|
||||
"""
|
||||
Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
|
||||
"""
|
||||
@@ -0,0 +1,32 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._request_options import RequestOptions
|
||||
from typing import List
|
||||
from typing_extensions import Literal, NotRequired
|
||||
|
||||
|
||||
class PhysicalBundleListParams(RequestOptions):
|
||||
ending_before: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
||||
"""
|
||||
expand: NotRequired[List[str]]
|
||||
"""
|
||||
Specifies which fields in the response should be expanded.
|
||||
"""
|
||||
limit: NotRequired[int]
|
||||
"""
|
||||
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
||||
"""
|
||||
starting_after: NotRequired[str]
|
||||
"""
|
||||
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
||||
"""
|
||||
status: NotRequired[Literal["active", "inactive", "review"]]
|
||||
"""
|
||||
Only return physical bundles with the given status.
|
||||
"""
|
||||
type: NotRequired[Literal["custom", "standard"]]
|
||||
"""
|
||||
Only return physical bundles with the given type.
|
||||
"""
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user