stripe 17.1.0 → 17.2.0.pre.alpha.2

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

@@ -0,0 +1,263 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # Every time an applicant submits an application for a Charge Card product your platform offers, or every time your platform takes a proactive credit decision on an existing account, you must record the decision by creating a new `CreditUnderwritingRecord` object on a connected account.
+    #
+    # [Follow the guide](https://stripe.com/docs/issuing/credit/report-credit-decisions-and-manage-aans) to learn about your requirements as a platform.
+    class CreditUnderwritingRecord < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.credit_underwriting_record"
+      def self.object_name
+        "issuing.credit_underwriting_record"
+      end
+
+      class Application < ::Stripe::StripeObject
+        # The channel through which the applicant has submitted their application.
+        attr_reader :application_method
+        # Scope of demand made by the applicant.
+        attr_reader :purpose
+        # Date when the applicant submitted their application.
+        attr_reader :submitted_at
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class CreditUser < ::Stripe::StripeObject
+        # Email of the applicant or accountholder.
+        attr_reader :email
+        # Full name of the company or person.
+        attr_reader :name
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Decision < ::Stripe::StripeObject
+        class ApplicationRejected < ::Stripe::StripeObject
+          # Details about the `reasons.other` when present.
+          attr_reader :reason_other_explanation
+          # List of reasons why the application was rejected up to 4 reasons, in order of importance.
+          attr_reader :reasons
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class CreditLimitApproved < ::Stripe::StripeObject
+          # Credit amount approved. An approved credit limit is required before you can set a amount in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy).
+          attr_reader :amount
+          # 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
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class CreditLimitDecreased < ::Stripe::StripeObject
+          # Credit amount approved after decrease. An approved credit limit is required before you can set a amount in the [CreditPolicy API](https://stripe.com/docs/api/issuing/credit_policy).
+          attr_reader :amount
+          # 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
+          # Details about the `reasons.other` when present.
+          attr_reader :reason_other_explanation
+          # List of reasons why the existing credit was decreased, up to 4 reasons, in order of importance.
+          attr_reader :reasons
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class CreditLineClosed < ::Stripe::StripeObject
+          # Details about the `reasons.other` when present.
+          attr_reader :reason_other_explanation
+          # List of reasons why the existing account was closed, up to 4 reasons, in order of importance.
+          attr_reader :reasons
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Details about a decision application_rejected.
+        attr_reader :application_rejected
+        # Details about a decision credit_limit_approved.
+        attr_reader :credit_limit_approved
+        # Details about a decision credit_limit_decreased.
+        attr_reader :credit_limit_decreased
+        # Details about a decision credit_line_closed.
+        attr_reader :credit_line_closed
+        # Outcome of the decision.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {
+            application_rejected: ApplicationRejected,
+            credit_limit_approved: CreditLimitApproved,
+            credit_limit_decreased: CreditLimitDecreased,
+            credit_line_closed: CreditLineClosed,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class UnderwritingException < ::Stripe::StripeObject
+        # Written explanation for the exception.
+        attr_reader :explanation
+        # The decision before the exception was applied.
+        attr_reader :original_decision_type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # For decisions triggered by an application, details about the submission.
+      attr_reader :application
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The event that triggered the underwriting.
+      attr_reader :created_from
+      # Attribute for field credit_user
+      attr_reader :credit_user
+      # Date when a decision was made.
+      attr_reader :decided_at
+      # Details about the decision.
+      attr_reader :decision
+      # For underwriting initiated by an application, a decision must be taken 30 days after the submission.
+      attr_reader :decision_deadline
+      # 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
+      # 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.
+      attr_reader :metadata
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # File containing regulatory reporting data for the decision. Required if you are subject to this [reporting requirement](https://stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).
+      attr_reader :regulatory_reporting_file
+      # If an exception to the usual underwriting criteria was made for this application, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.
+      attr_reader :underwriting_exception
+
+      # Update a CreditUnderwritingRecord object to correct mistakes.
+      def correct(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object to correct mistakes.
+      def self.correct(credit_underwriting_record, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a CreditUnderwritingRecord object with information about a credit application submission.
+      def self.create_from_application(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/issuing/credit_underwriting_records/create_from_application",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
+      def self.create_from_proactive_review(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/issuing/credit_underwriting_records/create_from_proactive_review",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieves a list of CreditUnderwritingRecord 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/credit_underwriting_records",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object from a decision made on a credit application.
+      def report_decision(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object from a decision made on a credit application.
+      def self.report_decision(credit_underwriting_record, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {
+          application: Application,
+          credit_user: CreditUser,
+          decision: Decision,
+          underwriting_exception: UnderwritingException,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # Represents a record from the card network of a money movement or change in state for an Issuing dispute. These records are included in the settlement reports that we receive from networks and expose to users as Settlement objects.
+    class DisputeSettlementDetail < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.dispute_settlement_detail"
+      def self.object_name
+        "issuing.dispute_settlement_detail"
+      end
+
+      class NetworkData < ::Stripe::StripeObject
+        # 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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Disputed amount in the card’s currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
+      attr_reader :amount
+      # The card used to make the original transaction.
+      attr_reader :card
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The currency the original transaction was made in. 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
+      # The ID of the linked dispute.
+      attr_reader :dispute
+      # The type of event corresponding to this dispute settlement detail, representing the stage in the dispute network lifecycle.
+      attr_reader :event_type
+      # 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 card network for this dispute settlement detail. One of ["visa", "mastercard", "maestro"]
+      attr_reader :network
+      # 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
+      # The ID of the linked card network settlement.
+      attr_reader :settlement
+
+      # Returns a list of Issuing DisputeSettlementDetail 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/dispute_settlement_details",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { network_data: NetworkData }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # A fraud liability debit occurs when Stripe debits a platform's account for fraud losses on Issuing transactions.
+    class FraudLiabilityDebit < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.fraud_liability_debit"
+      def self.object_name
+        "issuing.fraud_liability_debit"
+      end
+
+      # Debited amount. This is equal to the disputed amount and is given in the card’s currency and in the smallest currency unit.
+      attr_reader :amount
+      # ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this debit.
+      attr_reader :balance_transaction
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The currency of the debit. 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
+      # The ID of the linked 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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
+      # Returns a list of Issuing FraudLiabilityDebit 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/fraud_liability_debits",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
+    class Settlement < APIResource
+      OBJECT_NAME = "issuing.settlement"
+      def self.object_name
+        "issuing.settlement"
+      end
+
+      # The Bank Identification Number reflecting this settlement record.
+      attr_reader :bin
+      # The date that the transactions are cleared and posted to user's accounts.
+      attr_reader :clearing_date
+      # 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
+      # Unique identifier for the object.
+      attr_reader :id
+      # The total interchange received as reimbursement for the transactions.
+      attr_reader :interchange_fees_amount
+      # 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
+      # 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.
+      attr_reader :metadata
+      # The total net amount required to settle with the network.
+      attr_reader :net_total_amount
+      # The card network for this settlement report. One of ["visa", "maestro"]
+      attr_reader :network
+      # The total amount of fees owed to the network.
+      attr_reader :network_fees_amount
+      # The Settlement Identification Number assigned by the network.
+      attr_reader :network_settlement_identifier
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The total amount of any additional fees assessed by the card network.
+      attr_reader :other_fees_amount
+      # The total number of additional fees assessed by the card network.
+      attr_reader :other_fees_count
+      # One of `international` or `uk_national_net`.
+      attr_reader :settlement_service
+      # The current processing status of this settlement.
+      attr_reader :status
+      # The total transaction amount reflected in this settlement.
+      attr_reader :transaction_amount
+      # The total number of transactions reflected in this settlement.
+      attr_reader :transaction_count
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

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

@@ -357,6 +357,8 @@ module Stripe
       attr_reader :object
       # Additional purchase information that is optionally provided by the merchant.
       attr_reader :purchase_details
+      # The ID of the [settlement](https://stripe.com/docs/api/issuing/settlements) to which this transaction belongs.
+      attr_reader :settlement
       # [Token](https://stripe.com/docs/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://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts

data/lib/stripe/resources/line_item.rb

@@ -9,6 +9,23 @@ module Stripe
       "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
@@ -27,6 +44,38 @@ module Stripe
       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
@@ -47,6 +96,8 @@ module Stripe
         @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.
@@ -61,19 +112,35 @@ module Stripe
     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://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.
+    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 = { discounts: Discount, taxes: Tax }
+      @inner_class_types = {
+        adjustable_quantity: AdjustableQuantity,
+        discounts: Discount,
+        display: Display,
+        tax_calculation_reference: TaxCalculationReference,
+        taxes: Tax,
+      }
     end
 
     def self.field_remappings

data/lib/stripe/resources/mandate.rb

@@ -4,6 +4,8 @@
 module Stripe
   # A Mandate is a record of the permission that your customer gives you to debit their payment method.
   class Mandate < APIResource
+    extend Stripe::APIOperations::List
+
     OBJECT_NAME = "mandate"
     def self.object_name
       "mandate"
@@ -53,6 +55,11 @@ module Stripe
     end
 
     class MultiUse < ::Stripe::StripeObject
+      # The amount of the payment on a multi use mandate.
+      attr_reader :amount
+      # The currency of the payment on a multi use mandate.
+      attr_reader :currency
+
       def self.inner_class_types
         @inner_class_types = {}
       end
@@ -207,8 +214,61 @@ module Stripe
       class Paypal < ::Stripe::StripeObject
         # The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
         attr_reader :billing_agreement_id
+        # Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
+        attr_reader :fingerprint
         # PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
         attr_reader :payer_id
+        # Owner's verified email. Values are verified or provided by PayPal directly
+        # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+        attr_reader :verified_email
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Payto < ::Stripe::StripeObject
+        # Amount that will be collected. It is required when `amount_type` is `fixed`.
+        attr_reader :amount
+        # The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
+        attr_reader :amount_type
+        # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
+        attr_reader :end_date
+        # The periodicity at which payments will be collected.
+        attr_reader :payment_schedule
+        # The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
+        attr_reader :payments_per_period
+        # The purpose for which payments are made. Defaults to retail.
+        attr_reader :purpose
+        # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
+        attr_reader :start_date
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Pix < ::Stripe::StripeObject
+        # Determines if the amount includes the IOF tax.
+        attr_reader :amount_includes_iof
+        # Type of amount.
+        attr_reader :amount_type
+        # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
+        attr_reader :end_date
+        # Schedule at which the future payments will be charged.
+        attr_reader :payment_schedule
+        # Subscription name displayed to buyers in their bank app.
+        attr_reader :reference
+        # Start date of the mandate, in `YYYY-MM-DD`.
+        attr_reader :start_date
 
         def self.inner_class_types
           @inner_class_types = {}
@@ -282,6 +342,10 @@ module Stripe
       attr_reader :nz_bank_account
       # Attribute for field paypal
       attr_reader :paypal
+      # Attribute for field payto
+      attr_reader :payto
+      # Attribute for field pix
+      attr_reader :pix
       # Attribute for field revolut_pay
       attr_reader :revolut_pay
       # Attribute for field sepa_debit
@@ -306,6 +370,8 @@ module Stripe
           naver_pay: NaverPay,
           nz_bank_account: NzBankAccount,
           paypal: Paypal,
+          payto: Payto,
+          pix: Pix,
           revolut_pay: RevolutPay,
           sepa_debit: SepaDebit,
           us_bank_account: UsBankAccount,
@@ -354,6 +420,11 @@ module Stripe
     # The type of the mandate.
     attr_reader :type
 
+    # Retrieves a list of Mandates for a given PaymentMethod.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/mandates", params: params, opts: opts)
+    end
+
     def self.inner_class_types
       @inner_class_types = {
         customer_acceptance: CustomerAcceptance,