stripe 13.4.1 → 17.0.1

data/lib/stripe/resources/discount.rb

@@ -11,5 +11,54 @@ module Stripe
     def self.object_name
       "discount"
     end
+
+    class Source < Stripe::StripeObject
+      # The coupon that was redeemed to create this discount.
+      attr_reader :coupon
+      # The source type of the discount.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
+    attr_reader :checkout_session
+    # The ID of the customer associated with this discount.
+    attr_reader :customer
+    # If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.
+    attr_reader :end
+    # The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.
+    attr_reader :id
+    # The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
+    attr_reader :invoice
+    # The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
+    attr_reader :invoice_item
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # The promotion code applied to create this discount.
+    attr_reader :promotion_code
+    # Attribute for field source
+    attr_reader :source
+    # Date that the coupon was applied.
+    attr_reader :start
+    # The subscription that this coupon is applied to, if it is applied to a particular subscription.
+    attr_reader :subscription
+    # The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
+    attr_reader :subscription_item
+    # Always true for a deleted object
+    attr_reader :deleted
+
+    def self.inner_class_types
+      @inner_class_types = { source: Source }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/dispute.rb

@@ -16,6 +16,398 @@ module Stripe
       "dispute"
     end
 
+    class Evidence < Stripe::StripeObject
+      class EnhancedEvidence < Stripe::StripeObject
+        class VisaCompellingEvidence3 < Stripe::StripeObject
+          class DisputedTransaction < Stripe::StripeObject
+            class ShippingAddress < Stripe::StripeObject
+              # City, district, suburb, town, or village.
+              attr_reader :city
+              # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+              attr_reader :country
+              # Address line 1, such as the street, PO Box, or company name.
+              attr_reader :line1
+              # Address line 2, such as the apartment, suite, unit, or building.
+              attr_reader :line2
+              # ZIP or postal code.
+              attr_reader :postal_code
+              # State, county, province, or region.
+              attr_reader :state
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # User Account ID used to log into business platform. Must be recognizable by the user.
+            attr_reader :customer_account_id
+            # Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
+            attr_reader :customer_device_fingerprint
+            # Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
+            attr_reader :customer_device_id
+            # The email address of the customer.
+            attr_reader :customer_email_address
+            # The IP address that the customer used when making the purchase.
+            attr_reader :customer_purchase_ip
+            # Categorization of disputed payment.
+            attr_reader :merchandise_or_services
+            # A description of the product or service that was sold.
+            attr_reader :product_description
+            # The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
+            attr_reader :shipping_address
+
+            def self.inner_class_types
+              @inner_class_types = { shipping_address: ShippingAddress }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class PriorUndisputedTransaction < Stripe::StripeObject
+            class ShippingAddress < Stripe::StripeObject
+              # City, district, suburb, town, or village.
+              attr_reader :city
+              # Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+              attr_reader :country
+              # Address line 1, such as the street, PO Box, or company name.
+              attr_reader :line1
+              # Address line 2, such as the apartment, suite, unit, or building.
+              attr_reader :line2
+              # ZIP or postal code.
+              attr_reader :postal_code
+              # State, county, province, or region.
+              attr_reader :state
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.
+            attr_reader :charge
+            # User Account ID used to log into business platform. Must be recognizable by the user.
+            attr_reader :customer_account_id
+            # Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
+            attr_reader :customer_device_fingerprint
+            # Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
+            attr_reader :customer_device_id
+            # The email address of the customer.
+            attr_reader :customer_email_address
+            # The IP address that the customer used when making the purchase.
+            attr_reader :customer_purchase_ip
+            # A description of the product or service that was sold.
+            attr_reader :product_description
+            # The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
+            attr_reader :shipping_address
+
+            def self.inner_class_types
+              @inner_class_types = { shipping_address: ShippingAddress }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.
+          attr_reader :disputed_transaction
+          # List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.
+          attr_reader :prior_undisputed_transactions
+
+          def self.inner_class_types
+            @inner_class_types = {
+              disputed_transaction: DisputedTransaction,
+              prior_undisputed_transactions: PriorUndisputedTransaction,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class VisaCompliance < Stripe::StripeObject
+          # A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute.
+          attr_reader :fee_acknowledged
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field visa_compelling_evidence_3
+        attr_reader :visa_compelling_evidence_3
+        # Attribute for field visa_compliance
+        attr_reader :visa_compliance
+
+        def self.inner_class_types
+          @inner_class_types = {
+            visa_compelling_evidence_3: VisaCompellingEvidence3,
+            visa_compliance: VisaCompliance,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.
+      attr_reader :access_activity_log
+      # The billing address provided by the customer.
+      attr_reader :billing_address
+      # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.
+      attr_reader :cancellation_policy
+      # An explanation of how and when the customer was shown your refund policy prior to purchase.
+      attr_reader :cancellation_policy_disclosure
+      # A justification for why the customer's subscription was not canceled.
+      attr_reader :cancellation_rebuttal
+      # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.
+      attr_reader :customer_communication
+      # The email address of the customer.
+      attr_reader :customer_email_address
+      # The name of the customer.
+      attr_reader :customer_name
+      # The IP address that the customer used when making the purchase.
+      attr_reader :customer_purchase_ip
+      # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.
+      attr_reader :customer_signature
+      # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.
+      attr_reader :duplicate_charge_documentation
+      # An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.
+      attr_reader :duplicate_charge_explanation
+      # The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.
+      attr_reader :duplicate_charge_id
+      # Attribute for field enhanced_evidence
+      attr_reader :enhanced_evidence
+      # A description of the product or service that was sold.
+      attr_reader :product_description
+      # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.
+      attr_reader :receipt
+      # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.
+      attr_reader :refund_policy
+      # Documentation demonstrating that the customer was shown your refund policy prior to purchase.
+      attr_reader :refund_policy_disclosure
+      # A justification for why the customer is not entitled to a refund.
+      attr_reader :refund_refusal_explanation
+      # The date on which the customer received or began receiving the purchased service, in a clear human-readable format.
+      attr_reader :service_date
+      # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.
+      attr_reader :service_documentation
+      # The address to which a physical product was shipped. You should try to include as complete address information as possible.
+      attr_reader :shipping_address
+      # The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.
+      attr_reader :shipping_carrier
+      # The date on which a physical product began its route to the shipping address, in a clear human-readable format.
+      attr_reader :shipping_date
+      # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.
+      attr_reader :shipping_documentation
+      # The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
+      attr_reader :shipping_tracking_number
+      # (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.
+      attr_reader :uncategorized_file
+      # Any additional evidence or statements.
+      attr_reader :uncategorized_text
+
+      def self.inner_class_types
+        @inner_class_types = { enhanced_evidence: EnhancedEvidence }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class EvidenceDetails < Stripe::StripeObject
+      class EnhancedEligibility < Stripe::StripeObject
+        class VisaCompellingEvidence3 < Stripe::StripeObject
+          # List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.
+          attr_reader :required_actions
+          # Visa Compelling Evidence 3.0 eligibility status.
+          attr_reader :status
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class VisaCompliance < Stripe::StripeObject
+          # Visa compliance eligibility status.
+          attr_reader :status
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field visa_compelling_evidence_3
+        attr_reader :visa_compelling_evidence_3
+        # Attribute for field visa_compliance
+        attr_reader :visa_compliance
+
+        def self.inner_class_types
+          @inner_class_types = {
+            visa_compelling_evidence_3: VisaCompellingEvidence3,
+            visa_compliance: VisaCompliance,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute.
+      attr_reader :due_by
+      # Attribute for field enhanced_eligibility
+      attr_reader :enhanced_eligibility
+      # Whether evidence has been staged for this dispute.
+      attr_reader :has_evidence
+      # Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed.
+      attr_reader :past_due
+      # The number of times evidence has been submitted. Typically, you may only submit evidence once.
+      attr_reader :submission_count
+
+      def self.inner_class_types
+        @inner_class_types = { enhanced_eligibility: EnhancedEligibility }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class PaymentMethodDetails < Stripe::StripeObject
+      class AmazonPay < Stripe::StripeObject
+        # The AmazonPay dispute type, chargeback or claim
+        attr_reader :dispute_type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Card < Stripe::StripeObject
+        # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
+        attr_reader :brand
+        # The type of dispute opened. Different case types may have varying fees and financial impact.
+        attr_reader :case_type
+        # The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.
+        attr_reader :network_reason_code
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Klarna < Stripe::StripeObject
+        # Chargeback loss reason mapped by Stripe from Klarna's chargeback loss reason
+        attr_reader :chargeback_loss_reason_code
+        # The reason for the dispute as defined by Klarna
+        attr_reader :reason_code
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Paypal < Stripe::StripeObject
+        # The ID of the dispute in PayPal.
+        attr_reader :case_id
+        # The reason for the dispute as defined by PayPal
+        attr_reader :reason_code
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field amazon_pay
+      attr_reader :amazon_pay
+      # Attribute for field card
+      attr_reader :card
+      # Attribute for field klarna
+      attr_reader :klarna
+      # Attribute for field paypal
+      attr_reader :paypal
+      # Payment method type.
+      attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { amazon_pay: AmazonPay, card: Card, klarna: Klarna, paypal: Paypal }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+    # Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).
+    attr_reader :amount
+    # List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.
+    attr_reader :balance_transactions
+    # ID of the charge that's disputed.
+    attr_reader :charge
+    # 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
+    # List of eligibility types that are included in `enhanced_evidence`.
+    attr_reader :enhanced_eligibility_types
+    # Attribute for field evidence
+    attr_reader :evidence
+    # Attribute for field evidence_details
+    attr_reader :evidence_details
+    # Unique identifier for the object.
+    attr_reader :id
+    # If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.
+    attr_reader :is_charge_refundable
+    # 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
+    # Network-dependent reason code for the dispute.
+    attr_reader :network_reason_code
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # ID of the PaymentIntent that's disputed.
+    attr_reader :payment_intent
+    # Attribute for field payment_method_details
+    attr_reader :payment_method_details
+    # Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).
+    attr_reader :reason
+    # The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.
+    attr_reader :status
+
     # Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
     #
     # The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
@@ -47,7 +439,7 @@ module Stripe
 
     # When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
     #
-    # Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://stripe.com/docs/disputes/categories).
+    # Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://docs.stripe.com/docs/disputes/categories).
     def self.update(dispute, params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -56,5 +448,17 @@ module Stripe
         opts: opts
       )
     end
+
+    def self.inner_class_types
+      @inner_class_types = {
+        evidence: Evidence,
+        evidence_details: EvidenceDetails,
+        payment_method_details: PaymentMethodDetails,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/entitlements/active_entitlement.rb

@@ -12,6 +12,17 @@ module Stripe
         "entitlements.active_entitlement"
       end
 
+      # The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.
+      attr_reader :feature
+      # 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
+      # A unique key you provide as your own system identifier. This may be up to 80 characters.
+      attr_reader :lookup_key
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
       # Retrieve a list of active entitlements for a customer
       def self.list(params = {}, opts = {})
         request_stripe_object(
@@ -21,6 +32,14 @@ module Stripe
           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/entitlements/active_entitlement_summary.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Entitlements
+    # A summary of a customer's active entitlements.
+    class ActiveEntitlementSummary < APIResource
+      OBJECT_NAME = "entitlements.active_entitlement_summary"
+      def self.object_name
+        "entitlements.active_entitlement_summary"
+      end
+
+      # The customer that is entitled to this feature.
+      attr_reader :customer
+      # The list of entitlements this customer has.
+      attr_reader :entitlements
+      # 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
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end

data/lib/stripe/resources/entitlements/feature.rb

@@ -15,6 +15,21 @@ module Stripe
         "entitlements.feature"
       end
 
+      # Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
+      attr_reader :active
+      # 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
+      # A unique key you provide as your own system identifier. This may be up to 80 characters.
+      attr_reader :lookup_key
+      # Set of key-value pairs 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 feature's name, for your own purpose, not meant to be displayable to the customer.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
       # Creates a feature
       def self.create(params = {}, opts = {})
         request_stripe_object(
@@ -44,6 +59,14 @@ module Stripe
           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/ephemeral_key.rb

@@ -11,6 +11,19 @@ module Stripe
       "ephemeral_key"
     end
 
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Time at which the key will expire. Measured in seconds since the Unix epoch.
+    attr_reader :expires
+    # 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
+    # The key's secret. You can use this value to make authorized requests to the Stripe API.
+    attr_reader :secret
+
     # Invalidates a short-lived API key for a given resource.
     def self.delete(key, params = {}, opts = {})
       request_stripe_object(
@@ -39,5 +52,13 @@ module Stripe
       end
       super
     end
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end