stripe 15.12.0 → 16.1.0

package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts

@@ -35,6 +35,16 @@ declare module 'stripe' {
            */
           expand?: Array<string>;
 
+          /**
+           * Fleet-specific information for authorizations using Fleet cards.
+           */
+          fleet?: AuthorizationCreateParams.Fleet;
+
+          /**
+           * Information about fuel that was purchased with this transaction.
+           */
+          fuel?: AuthorizationCreateParams.Fuel;
+
           /**
            * 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.
            */
@@ -81,6 +91,158 @@ declare module 'stripe' {
             | 'online'
             | 'swipe';
 
+          interface Fleet {
+            /**
+             * 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.
+             */
+            cardholder_prompt_data?: Fleet.CardholderPromptData;
+
+            /**
+             * The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
+             */
+            purchase_type?: Fleet.PurchaseType;
+
+            /**
+             * More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
+             */
+            reported_breakdown?: Fleet.ReportedBreakdown;
+
+            /**
+             * The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
+             */
+            service_type?: Fleet.ServiceType;
+          }
+
+          namespace Fleet {
+            interface CardholderPromptData {
+              /**
+               * Driver ID.
+               */
+              driver_id?: string;
+
+              /**
+               * Odometer reading.
+               */
+              odometer?: number;
+
+              /**
+               * 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.
+               */
+              unspecified_id?: string;
+
+              /**
+               * User ID.
+               */
+              user_id?: string;
+
+              /**
+               * Vehicle number.
+               */
+              vehicle_number?: string;
+            }
+
+            type PurchaseType =
+              | 'fuel_and_non_fuel_purchase'
+              | 'fuel_purchase'
+              | 'non_fuel_purchase';
+
+            interface ReportedBreakdown {
+              /**
+               * Breakdown of fuel portion of the purchase.
+               */
+              fuel?: ReportedBreakdown.Fuel;
+
+              /**
+               * Breakdown of non-fuel portion of the purchase.
+               */
+              non_fuel?: ReportedBreakdown.NonFuel;
+
+              /**
+               * Information about tax included in this transaction.
+               */
+              tax?: ReportedBreakdown.Tax;
+            }
+
+            namespace ReportedBreakdown {
+              interface Fuel {
+                /**
+                 * Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+                 */
+                gross_amount_decimal?: string;
+              }
+
+              interface NonFuel {
+                /**
+                 * Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
+                 */
+                gross_amount_decimal?: string;
+              }
+
+              interface Tax {
+                /**
+                 * Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
+                 */
+                local_amount_decimal?: string;
+
+                /**
+                 * Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
+                 */
+                national_amount_decimal?: string;
+              }
+            }
+
+            type ServiceType =
+              | 'full_service'
+              | 'non_fuel_transaction'
+              | 'self_service';
+          }
+
+          interface Fuel {
+            /**
+             * [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
+             */
+            industry_product_code?: string;
+
+            /**
+             * The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
+             */
+            quantity_decimal?: string;
+
+            /**
+             * The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
+             */
+            type?: Fuel.Type;
+
+            /**
+             * The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
+             */
+            unit?: Fuel.Unit;
+
+            /**
+             * The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
+             */
+            unit_cost_decimal?: string;
+          }
+
+          namespace Fuel {
+            type Type =
+              | 'diesel'
+              | 'other'
+              | 'unleaded_plus'
+              | 'unleaded_regular'
+              | 'unleaded_super';
+
+            type Unit =
+              | 'charging_minute'
+              | 'imperial_gallon'
+              | 'kilogram'
+              | 'kilowatt_hour'
+              | 'liter'
+              | 'other'
+              | 'pound'
+              | 'us_gallon';
+          }
+
           interface MerchantData {
             /**
              * 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.
@@ -540,6 +702,11 @@ declare module 'stripe' {
 
         namespace AuthorizationCaptureParams {
           interface PurchaseDetails {
+            /**
+             * Fleet-specific information for transactions using Fleet cards.
+             */
+            fleet?: PurchaseDetails.Fleet;
+
             /**
              * Information about the flight that was purchased with this transaction.
              */
@@ -567,6 +734,112 @@ declare module 'stripe' {
           }
 
           namespace PurchaseDetails {
+            interface Fleet {
+              /**
+               * 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.
+               */
+              cardholder_prompt_data?: Fleet.CardholderPromptData;
+
+              /**
+               * The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
+               */
+              purchase_type?: Fleet.PurchaseType;
+
+              /**
+               * More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
+               */
+              reported_breakdown?: Fleet.ReportedBreakdown;
+
+              /**
+               * The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
+               */
+              service_type?: Fleet.ServiceType;
+            }
+
+            namespace Fleet {
+              interface CardholderPromptData {
+                /**
+                 * Driver ID.
+                 */
+                driver_id?: string;
+
+                /**
+                 * Odometer reading.
+                 */
+                odometer?: number;
+
+                /**
+                 * 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.
+                 */
+                unspecified_id?: string;
+
+                /**
+                 * User ID.
+                 */
+                user_id?: string;
+
+                /**
+                 * Vehicle number.
+                 */
+                vehicle_number?: string;
+              }
+
+              type PurchaseType =
+                | 'fuel_and_non_fuel_purchase'
+                | 'fuel_purchase'
+                | 'non_fuel_purchase';
+
+              interface ReportedBreakdown {
+                /**
+                 * Breakdown of fuel portion of the purchase.
+                 */
+                fuel?: ReportedBreakdown.Fuel;
+
+                /**
+                 * Breakdown of non-fuel portion of the purchase.
+                 */
+                non_fuel?: ReportedBreakdown.NonFuel;
+
+                /**
+                 * Information about tax included in this transaction.
+                 */
+                tax?: ReportedBreakdown.Tax;
+              }
+
+              namespace ReportedBreakdown {
+                interface Fuel {
+                  /**
+                   * Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+                   */
+                  gross_amount_decimal?: string;
+                }
+
+                interface NonFuel {
+                  /**
+                   * Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
+                   */
+                  gross_amount_decimal?: string;
+                }
+
+                interface Tax {
+                  /**
+                   * Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
+                   */
+                  local_amount_decimal?: string;
+
+                  /**
+                   * Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
+                   */
+                  national_amount_decimal?: string;
+                }
+              }
+
+              type ServiceType =
+                | 'full_service'
+                | 'non_fuel_transaction'
+                | 'self_service';
+            }
+
             interface Flight {
               /**
                * The time that the flight departed.
@@ -629,13 +902,23 @@ declare module 'stripe' {
             }
 
             interface Fuel {
+              /**
+               * [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
+               */
+              industry_product_code?: string;
+
+              /**
+               * The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
+               */
+              quantity_decimal?: string;
+
               /**
                * The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
                */
               type?: Fuel.Type;
 
               /**
-               * The units for `volume_decimal`. One of `liter`, `us_gallon`, or `other`.
+               * The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
                */
               unit?: Fuel.Unit;
 
@@ -643,11 +926,6 @@ declare module 'stripe' {
                * The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
                */
               unit_cost_decimal?: string;
-
-              /**
-               * The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.
-               */
-              volume_decimal?: string;
             }
 
             namespace Fuel {
@@ -658,7 +936,15 @@ declare module 'stripe' {
                 | 'unleaded_regular'
                 | 'unleaded_super';
 
-              type Unit = 'liter' | 'other' | 'us_gallon';
+              type Unit =
+                | 'charging_minute'
+                | 'imperial_gallon'
+                | 'kilogram'
+                | 'kilowatt_hour'
+                | 'liter'
+                | 'other'
+                | 'pound'
+                | 'us_gallon';
             }
 
             interface Lodging {
@@ -695,6 +981,184 @@ declare module 'stripe' {
         }
       }
 
+      namespace Issuing {
+        interface AuthorizationFinalizeAmountParams {
+          /**
+           * 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).
+           */
+          final_amount: number;
+
+          /**
+           * Specifies which fields in the response should be expanded.
+           */
+          expand?: Array<string>;
+
+          /**
+           * Fleet-specific information for authorizations using Fleet cards.
+           */
+          fleet?: AuthorizationFinalizeAmountParams.Fleet;
+
+          /**
+           * Information about fuel that was purchased with this transaction.
+           */
+          fuel?: AuthorizationFinalizeAmountParams.Fuel;
+        }
+
+        namespace AuthorizationFinalizeAmountParams {
+          interface Fleet {
+            /**
+             * 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.
+             */
+            cardholder_prompt_data?: Fleet.CardholderPromptData;
+
+            /**
+             * The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
+             */
+            purchase_type?: Fleet.PurchaseType;
+
+            /**
+             * More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
+             */
+            reported_breakdown?: Fleet.ReportedBreakdown;
+
+            /**
+             * The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
+             */
+            service_type?: Fleet.ServiceType;
+          }
+
+          namespace Fleet {
+            interface CardholderPromptData {
+              /**
+               * Driver ID.
+               */
+              driver_id?: string;
+
+              /**
+               * Odometer reading.
+               */
+              odometer?: number;
+
+              /**
+               * 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.
+               */
+              unspecified_id?: string;
+
+              /**
+               * User ID.
+               */
+              user_id?: string;
+
+              /**
+               * Vehicle number.
+               */
+              vehicle_number?: string;
+            }
+
+            type PurchaseType =
+              | 'fuel_and_non_fuel_purchase'
+              | 'fuel_purchase'
+              | 'non_fuel_purchase';
+
+            interface ReportedBreakdown {
+              /**
+               * Breakdown of fuel portion of the purchase.
+               */
+              fuel?: ReportedBreakdown.Fuel;
+
+              /**
+               * Breakdown of non-fuel portion of the purchase.
+               */
+              non_fuel?: ReportedBreakdown.NonFuel;
+
+              /**
+               * Information about tax included in this transaction.
+               */
+              tax?: ReportedBreakdown.Tax;
+            }
+
+            namespace ReportedBreakdown {
+              interface Fuel {
+                /**
+                 * Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+                 */
+                gross_amount_decimal?: string;
+              }
+
+              interface NonFuel {
+                /**
+                 * Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
+                 */
+                gross_amount_decimal?: string;
+              }
+
+              interface Tax {
+                /**
+                 * Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
+                 */
+                local_amount_decimal?: string;
+
+                /**
+                 * Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
+                 */
+                national_amount_decimal?: string;
+              }
+            }
+
+            type ServiceType =
+              | 'full_service'
+              | 'non_fuel_transaction'
+              | 'self_service';
+          }
+
+          interface Fuel {
+            /**
+             * [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
+             */
+            industry_product_code?: string;
+
+            /**
+             * The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
+             */
+            quantity_decimal?: string;
+
+            /**
+             * The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
+             */
+            type?: Fuel.Type;
+
+            /**
+             * The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
+             */
+            unit?: Fuel.Unit;
+
+            /**
+             * The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
+             */
+            unit_cost_decimal?: string;
+          }
+
+          namespace Fuel {
+            type Type =
+              | 'diesel'
+              | 'other'
+              | 'unleaded_plus'
+              | 'unleaded_regular'
+              | 'unleaded_super';
+
+            type Unit =
+              | 'charging_minute'
+              | 'imperial_gallon'
+              | 'kilogram'
+              | 'kilowatt_hour'
+              | 'liter'
+              | 'other'
+              | 'pound'
+              | 'us_gallon';
+          }
+        }
+      }
+
       namespace Issuing {
         interface AuthorizationIncrementParams {
           /**
@@ -764,6 +1228,15 @@ declare module 'stripe' {
             options?: RequestOptions
           ): Promise<Stripe.Response<Stripe.Issuing.Authorization>>;
 
+          /**
+           * Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.
+           */
+          finalizeAmount(
+            id: string,
+            params: AuthorizationFinalizeAmountParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.Issuing.Authorization>>;
+
           /**
            * Increment a test-mode Authorization.
            */