stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/resources/issuing/transaction.rb

@@ -3,11 +3,455 @@
 
 module Stripe
   module Issuing
+    # Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving
+    # your Stripe account, such as a completed purchase or refund, is represented by an Issuing
+    # `Transaction` object.
+    #
+    # Related guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions)
     class Transaction < APIResource
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save
 
       OBJECT_NAME = "issuing.transaction"
+      def self.object_name
+        "issuing.transaction"
+      end
+
+      class AmountDetails < ::Stripe::StripeObject
+        # The fee charged by the ATM for the cash withdrawal.
+        attr_reader :atm_fee
+        # The amount of cash requested by the cardholder.
+        attr_reader :cashback_amount
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class MerchantData < ::Stripe::StripeObject
+        # A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values.
+        attr_reader :category
+        # The merchant category code for the seller’s business
+        attr_reader :category_code
+        # City where the seller is located
+        attr_reader :city
+        # Country where the seller is located
+        attr_reader :country
+        # Name of the seller
+        attr_reader :name
+        # Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.
+        attr_reader :network_id
+        # Postal code where the seller is located
+        attr_reader :postal_code
+        # State where the seller is located
+        attr_reader :state
+        # The seller's tax identification number. Currently populated for French merchants only.
+        attr_reader :tax_id
+        # An ID assigned by the seller to the location of the sale.
+        attr_reader :terminal_id
+        # URL provided by the merchant on a 3DS request
+        attr_reader :url
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class NetworkData < ::Stripe::StripeObject
+        # A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.
+        attr_reader :authorization_code
+        # The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.
+        attr_reader :processing_date
+        # Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.
+        attr_reader :transaction_id
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class PurchaseDetails < ::Stripe::StripeObject
+        class Fleet < ::Stripe::StripeObject
+          class CardholderPromptData < ::Stripe::StripeObject
+            # Driver ID.
+            attr_reader :driver_id
+            # Odometer reading.
+            attr_reader :odometer
+            # 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.
+            attr_reader :unspecified_id
+            # User ID.
+            attr_reader :user_id
+            # Vehicle number.
+            attr_reader :vehicle_number
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class ReportedBreakdown < ::Stripe::StripeObject
+            class Fuel < ::Stripe::StripeObject
+              # Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+              attr_reader :gross_amount_decimal
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+
+            class NonFuel < ::Stripe::StripeObject
+              # Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.
+              attr_reader :gross_amount_decimal
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+
+            class Tax < ::Stripe::StripeObject
+              # Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.
+              attr_reader :local_amount_decimal
+              # Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.
+              attr_reader :national_amount_decimal
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Breakdown of fuel portion of the purchase.
+            attr_reader :fuel
+            # Breakdown of non-fuel portion of the purchase.
+            attr_reader :non_fuel
+            # Information about tax included in this transaction.
+            attr_reader :tax
+
+            def self.inner_class_types
+              @inner_class_types = { fuel: Fuel, non_fuel: NonFuel, tax: Tax }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Answers to prompts presented to cardholder at point of sale.
+          attr_reader :cardholder_prompt_data
+          # The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.
+          attr_reader :purchase_type
+          # More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.
+          attr_reader :reported_breakdown
+          # The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.
+          attr_reader :service_type
+
+          def self.inner_class_types
+            @inner_class_types = {
+              cardholder_prompt_data: CardholderPromptData,
+              reported_breakdown: ReportedBreakdown,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Flight < ::Stripe::StripeObject
+          class Segment < ::Stripe::StripeObject
+            # The three-letter IATA airport code of the flight's destination.
+            attr_reader :arrival_airport_code
+            # The airline carrier code.
+            attr_reader :carrier
+            # The three-letter IATA airport code that the flight departed from.
+            attr_reader :departure_airport_code
+            # The flight number.
+            attr_reader :flight_number
+            # The flight's service class.
+            attr_reader :service_class
+            # Whether a stopover is allowed on this flight.
+            attr_reader :stopover_allowed
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The time that the flight departed.
+          attr_reader :departure_at
+          # The name of the passenger.
+          attr_reader :passenger_name
+          # Whether the ticket is refundable.
+          attr_reader :refundable
+          # The legs of the trip.
+          attr_reader :segments
+          # The travel agency that issued the ticket.
+          attr_reader :travel_agency
+
+          def self.inner_class_types
+            @inner_class_types = { segments: Segment }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Fuel < ::Stripe::StripeObject
+          # [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.
+          attr_reader :industry_product_code
+          # The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.
+          attr_reader :quantity_decimal
+          # The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.
+          attr_reader :type
+          # The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.
+          attr_reader :unit
+          # The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.
+          attr_reader :unit_cost_decimal
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Lodging < ::Stripe::StripeObject
+          # The time of checking into the lodging.
+          attr_reader :check_in_at
+          # The number of nights stayed at the lodging.
+          attr_reader :nights
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Receipt < ::Stripe::StripeObject
+          # The description of the item. The maximum length of this field is 26 characters.
+          attr_reader :description
+          # The quantity of the item.
+          attr_reader :quantity
+          # The total for this line item in cents.
+          attr_reader :total
+          # The unit cost of the item in cents.
+          attr_reader :unit_cost
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Fleet-specific information for transactions using Fleet cards.
+        attr_reader :fleet
+        # Information about the flight that was purchased with this transaction.
+        attr_reader :flight
+        # Information about fuel that was purchased with this transaction.
+        attr_reader :fuel
+        # Information about lodging that was purchased with this transaction.
+        attr_reader :lodging
+        # The line items in the purchase.
+        attr_reader :receipt
+        # A merchant-specific order number.
+        attr_reader :reference
+
+        def self.inner_class_types
+          @inner_class_types = {
+            fleet: Fleet,
+            flight: Flight,
+            fuel: Fuel,
+            lodging: Lodging,
+            receipt: Receipt,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Treasury < ::Stripe::StripeObject
+        # The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund
+        attr_reader :received_credit
+        # The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) representing this Issuing transaction if it is a capture
+        attr_reader :received_debit
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+      attr_reader :amount
+      # Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+      attr_reader :amount_details
+      # The `Authorization` object that led to this transaction.
+      attr_reader :authorization
+      # ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction.
+      attr_reader :balance_transaction
+      # The card used to make this transaction.
+      attr_reader :card
+      # The cardholder to whom this transaction belongs.
+      attr_reader :cardholder
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # 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).
+      attr_reader :currency
+      # If you've disputed the transaction, the ID of the dispute.
+      attr_reader :dispute
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.
+      attr_reader :merchant_amount
+      # The currency with which the merchant is taking payment.
+      attr_reader :merchant_currency
+      # Attribute for field merchant_data
+      attr_reader :merchant_data
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+      attr_reader :metadata
+      # Details about the transaction, such as processing dates, set by the card network.
+      attr_reader :network_data
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Additional purchase information that is optionally provided by the merchant.
+      attr_reader :purchase_details
+      # The ID of the [settlement](https://docs.stripe.com/api/issuing/settlements) to which this transaction belongs.
+      attr_reader :settlement
+      # [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.
+      attr_reader :token
+      # [Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts
+      attr_reader :treasury
+      # The nature of the transaction.
+      attr_reader :type
+      # The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`.
+      attr_reader :wallet
+
+      # Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/issuing/transactions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+      def self.update(transaction, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/transactions/%<transaction>s", { transaction: CGI.escape(transaction) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = Transaction
+        def self.resource_class
+          "Transaction"
+        end
+
+        # Allows the user to capture an arbitrary amount, also known as a forced capture.
+        def self.create_force_capture(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/issuing/transactions/create_force_capture",
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Allows the user to refund an arbitrary amount, also known as a unlinked refund.
+        def self.create_unlinked_refund(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/issuing/transactions/create_unlinked_refund",
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Refund a test-mode Transaction.
+        def self.refund(transaction, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/transactions/%<transaction>s/refund", { transaction: CGI.escape(transaction) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Refund a test-mode Transaction.
+        def refund(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/transactions/%<transaction>s/refund", { transaction: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          amount_details: AmountDetails,
+          merchant_data: MerchantData,
+          network_data: NetworkData,
+          purchase_details: PurchaseDetails,
+          treasury: Treasury,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
   end
 end

data/lib/stripe/resources/line_item.rb

@@ -2,7 +2,149 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A line item.
   class LineItem < APIResource
     OBJECT_NAME = "item"
+    def self.object_name
+      "item"
+    end
+
+    class AdjustableQuantity < ::Stripe::StripeObject
+      # Attribute for field enabled
+      attr_reader :enabled
+      # Attribute for field maximum
+      attr_reader :maximum
+      # Attribute for field minimum
+      attr_reader :minimum
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Discount < ::Stripe::StripeObject
+      # The amount discounted.
+      attr_reader :amount
+      # A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
+      # It contains information about when the discount began, when it will end, and what it is applied to.
+      #
+      # Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
+      attr_reader :discount
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Display < ::Stripe::StripeObject
+      # Attribute for field description
+      attr_reader :description
+      # Attribute for field images
+      attr_reader :images
+      # Attribute for field name
+      attr_reader :name
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class TaxCalculationReference < ::Stripe::StripeObject
+      # The calculation identifier for tax calculation response.
+      attr_reader :calculation_id
+      # The calculation identifier for tax calculation response line item.
+      attr_reader :calculation_item_id
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class Tax < ::Stripe::StripeObject
+      # Amount of tax applied for this rate.
+      attr_reader :amount
+      # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
+      #
+      # Related guide: [Tax rates](/billing/taxes/tax-rates)
+      attr_reader :rate
+      # The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
+      attr_reader :taxability_reason
+      # The amount on which tax is calculated, in cents (or local equivalent).
+      attr_reader :taxable_amount
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Attribute for field adjustable_quantity
+    attr_reader :adjustable_quantity
+    # Total discount amount applied. If no discounts were applied, defaults to 0.
+    attr_reader :amount_discount
+    # Total before any discounts or taxes are applied.
+    attr_reader :amount_subtotal
+    # Total tax amount applied. If no tax was applied, defaults to 0.
+    attr_reader :amount_tax
+    # Total after discounts and taxes.
+    attr_reader :amount_total
+    # 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).
+    attr_reader :currency
+    # An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
+    attr_reader :description
+    # The discounts applied to the line item.
+    attr_reader :discounts
+    # Attribute for field display
+    attr_reader :display
+    # Unique identifier for the object.
+    attr_reader :id
+    # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The price used to generate the line item.
+    attr_reader :price
+    # The ID of the product for this line item.
+    #
+    # This will always be the same as `price.product`.
+    attr_reader :product
+    # The quantity of products being purchased.
+    attr_reader :quantity
+    # The tax calculation identifiers of the line item.
+    attr_reader :tax_calculation_reference
+    # The taxes applied to the line item.
+    attr_reader :taxes
+
+    def self.inner_class_types
+      @inner_class_types = {
+        adjustable_quantity: AdjustableQuantity,
+        discounts: Discount,
+        display: Display,
+        tax_calculation_reference: TaxCalculationReference,
+        taxes: Tax,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/login_link.rb

@@ -2,8 +2,20 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard.
+  # A Login Link differs from an [Account Link](https://docs.stripe.com/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://docs.stripe.com/connect/integrate-express-dashboard#create-login-link)
   class LoginLink < APIResource
     OBJECT_NAME = "login_link"
+    def self.object_name
+      "login_link"
+    end
+
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The URL for the login link.
+    attr_reader :url
 
     def self.retrieve(_id, _opts = nil)
       raise NotImplementedError,
@@ -11,5 +23,13 @@ module Stripe
             "only be created using `Account.create_login_link('account_id', " \
             "create_params)`"
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end