stripe 3.3.1 → 5.38.0

data/lib/stripe/{account.rb → resources/account.rb}

@@ -1,21 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
 module Stripe
   class Account < APIResource
     extend Gem::Deprecate
     extend Stripe::APIOperations::Create
-    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
+
+    OBJECT_NAME = "account"
 
-    OBJECT_NAME = 'account'
+    custom_method :reject, http_verb: :post
+
+    nested_resource_class_methods :capability,
+                                  operations: %i[retrieve update list],
+                                  resource_plural: "capabilities"
+    nested_resource_class_methods :person,
+                                  operations: %i[create retrieve update delete list]
+
+    def reject(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/reject",
+        params: params,
+        opts: opts
+      )
+    end
 
     save_nested_resource :external_account
 
-    # This method is deprecated. Please use `#external_account=` instead.
-    save_nested_resource :bank_account
-    deprecate :bank_account=, "#external_account=", 2017, 8
+    nested_resource_class_methods :external_account,
+                                  operations: %i[create retrieve update delete list]
+
+    nested_resource_class_methods :login_link, operations: %i[create]
 
     def resource_url
-      if self['id']
+      if self["id"]
         super
       else
         "/v1/account"
@@ -23,26 +45,30 @@ module Stripe
     end
 
     # @override To make id optional
-    def self.retrieve(id=ARGUMENT_NOT_PROVIDED, opts={})
-      id = id.equal?(ARGUMENT_NOT_PROVIDED) ? nil : Util.check_string_argument!(id)
+    def self.retrieve(id = nil, opts = {})
+      Util.check_string_argument!(id) if id
 
       # Account used to be a singleton, where this method's signature was
       # `(opts={})`. For the sake of not breaking folks who pass in an OAuth
       # key in opts, let's lurkily string match for it.
-      if opts == {} && id.is_a?(String) && id.start_with?('sk_')
-        # `super` properly assumes a String opts is the apiKey and normalizes as expected.
+      if opts == {} && id.is_a?(String) && id.start_with?("sk_")
+        # `super` properly assumes a String opts is the apiKey and normalizes
+        # as expected.
         opts = id
         id = nil
       end
       super(id, opts)
     end
 
-    def reject(params={}, opts={})
-      opts = Util.normalize_opts(opts)
-      resp, opts = request(:post, resource_url + '/reject', params, opts)
-      initialize_from(resp.data, opts)
+    def persons(params = {}, opts = {})
+      resp, opts = execute_resource_request(:get, resource_url + "/persons", params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
     end
 
+    # We are not adding a helper for capabilities here as the Account object
+    # already has a capabilities property which is a hash and not the sub-list
+    # of capabilities.
+
     # Somewhat unfortunately, we attempt to do a special encoding trick when
     # serializing `additional_owners` under an account: when updating a value,
     # we actually send the update parameters up as an integer-indexed hash
@@ -67,17 +93,22 @@ module Stripe
     # We're trying to get this overturned on the server side, but for now,
     # patch in a special allowance.
     def serialize_params(options = {})
-      serialize_params_account(self, super)
+      serialize_params_account(self, super, options)
     end
 
-    def serialize_params_account(obj, update_hash)
-      if entity = @values[:legal_entity]
-        if owners = entity[:additional_owners]
+    def serialize_params_account(_obj, update_hash, options = {})
+      if (entity = @values[:legal_entity])
+        if (owners = entity[:additional_owners])
           entity_update = update_hash[:legal_entity] ||= {}
           entity_update[:additional_owners] =
             serialize_additional_owners(entity, owners)
         end
       end
+      if (individual = @values[:individual])
+        if individual.is_a?(Person) && !update_hash.key?(:individual)
+          update_hash[:individual] = individual.serialize_params(options)
+        end
+      end
       update_hash
     end
 
@@ -86,34 +117,36 @@ module Stripe
     end
 
     def legal_entity
-      self['legal_entity']
+      self["legal_entity"]
     end
 
-    def legal_entity=(_)
-      raise NoMethodError.new('Overridding legal_entity can cause serious issues. Instead, set the individual fields of legal_entity like blah.legal_entity.first_name = \'Blah\'')
+    def legal_entity=(_legal_entity)
+      raise NoMethodError,
+            "Overriding legal_entity can cause serious issues. Instead, set " \
+            "the individual fields of legal_entity like " \
+            "`account.legal_entity.first_name = 'Blah'`"
     end
 
-    def deauthorize(client_id=nil, opts={})
+    def deauthorize(client_id = nil, opts = {})
       params = {
         client_id: client_id,
-        stripe_user_id: self.id,
+        stripe_user_id: id,
       }
+      opts = @opts.merge(Util.normalize_opts(opts))
       OAuth.deauthorize(params, opts)
     end
 
-    ARGUMENT_NOT_PROVIDED = Object.new
-
-    private
-
-    def serialize_additional_owners(legal_entity, additional_owners)
-      original_value = legal_entity.instance_variable_get(:@original_values)[:additional_owners]
+    private def serialize_additional_owners(legal_entity, additional_owners)
+      original_value =
+        legal_entity
+        .instance_variable_get(:@original_values)[:additional_owners]
       if original_value && original_value.length > additional_owners.length
         # url params provide no mechanism for deleting an item in an array,
         # just overwriting the whole array or adding new items. So let's not
         # allow deleting without a full overwrite until we have a solution.
-        raise ArgumentError.new(
-          "You cannot delete an item from an array, you must instead set a new array"
-        )
+        raise ArgumentError,
+              "You cannot delete an item from an array, you must instead " \
+              "set a new array"
       end
 
       update_hash = {}
@@ -125,10 +158,11 @@ module Stripe
         # StripeObject.
         update = v.is_a?(StripeObject) ? v.serialize_params : v
 
-        if update != {} && (!original_value ||
-          update != legal_entity.serialize_params_value(original_value[i], nil, false, true))
-            update_hash[i.to_s] = update
-        end
+        next unless update != {} && (!original_value ||
+          update != legal_entity.serialize_params_value(original_value[i], nil,
+                                                        false, true))
+
+        update_hash[i.to_s] = update
       end
       update_hash
     end

data/lib/stripe/resources/account_link.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountLink < APIResource
+    extend Stripe::APIOperations::Create
+
+    OBJECT_NAME = "account_link"
+  end
+end

data/lib/stripe/resources/alipay_account.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Stripe
+  class AlipayAccount < APIResource
+    include Stripe::APIOperations::Save
+    include Stripe::APIOperations::Delete
+
+    OBJECT_NAME = "alipay_account"
+
+    def resource_url
+      if !respond_to?(:customer) || customer.nil?
+        raise NotImplementedError,
+              "Alipay accounts cannot be accessed without a customer ID."
+      end
+
+      "#{Customer.resource_url}/#{CGI.escape(customer)}/sources" \
+      "/#{CGI.escape(id)}"
+    end
+
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError,
+            "Alipay accounts cannot be updated without a customer ID. " \
+            "Update an Alipay account using `Customer.update_source(" \
+            "'customer_id', 'alipay_account_id', update_params)`"
+    end
+
+    def self.retrieve(_id, _opts = nil)
+      raise NotImplementedError,
+            "Alipay accounts cannot be retrieved without a customer ID. " \
+            "Retrieve an Alipay account using `Customer.retrieve_source(" \
+            "'customer_id', 'alipay_account_id')`"
+    end
+  end
+end

data/lib/stripe/{apple_pay_domain.rb → resources/apple_pay_domain.rb}

@@ -1,3 +1,6 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
 module Stripe
   # Domains registered for Apple Pay on the Web
   class ApplePayDomain < APIResource
@@ -5,10 +8,10 @@ module Stripe
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'apple_pay_domain'
+    OBJECT_NAME = "apple_pay_domain"
 
     def self.resource_url
-      '/v1/apple_pay/domains'
+      "/v1/apple_pay/domains"
     end
   end
 end

data/lib/stripe/resources/application_fee.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ApplicationFee < APIResource
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::NestedResource
+
+    OBJECT_NAME = "application_fee"
+
+    nested_resource_class_methods :refund,
+                                  operations: %i[create retrieve update list]
+  end
+end

data/lib/stripe/resources/application_fee_refund.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ApplicationFeeRefund < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "fee_refund"
+
+    def resource_url
+      "#{ApplicationFee.resource_url}/#{CGI.escape(fee)}/refunds" \
+      "/#{CGI.escape(id)}"
+    end
+
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError,
+            "Application fee refunds cannot be updated without an " \
+            "application fee ID. Update an application fee refund using " \
+            "`ApplicationFee.update_refund('fee_id', 'refund_id', " \
+            "update_params)`"
+    end
+
+    def self.retrieve(_id, _api_key = nil)
+      raise NotImplementedError,
+            "Application fee refunds cannot be retrieved without an " \
+            "application fee ID. Retrieve an application fee refund using " \
+            "`ApplicationFee.retrieve_refund('fee_id', 'refund_id')`"
+    end
+  end
+end

data/lib/stripe/resources/balance.rb

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Balance < SingletonAPIResource
+    OBJECT_NAME = "balance"
+  end
+end

data/lib/stripe/resources/balance_transaction.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class BalanceTransaction < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "balance_transaction"
+  end
+end

data/lib/stripe/resources/bank_account.rb

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class BankAccount < APIResource
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "bank_account"
+
+    def verify(params = {}, opts = {})
+      resp, opts = execute_resource_request(:post, resource_url + "/verify", params, opts)
+      initialize_from(resp.data, opts)
+    end
+
+    def resource_url
+      if respond_to?(:customer)
+        "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
+      elsif respond_to?(:account)
+        "#{Account.resource_url}/#{CGI.escape(account)}/external_accounts/#{CGI.escape(id)}"
+      end
+    end
+
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError,
+            "Bank accounts cannot be updated without a customer ID or an " \
+            " account ID. Update a bank account using " \
+            "`Customer.update_source('customer_id', 'bank_account_id', " \
+            "update_params)` or `Account.update_external_account(" \
+            "'account_id', 'bank_account_id', update_params)`"
+    end
+
+    def self.retrieve(_id, _opts = nil)
+      raise NotImplementedError,
+            "Bank accounts cannot be retrieve without a customer ID or an " \
+            "account ID. Retrieve a bank account using " \
+            "`Customer.retrieve_source('customer_id', 'bank_account_id')` " \
+            "or `Account.retrieve_external_account('account_id', " \
+            "'bank_account_id')`"
+    end
+  end
+end

data/lib/stripe/resources/billing_portal/configuration.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module BillingPortal
+    class Configuration < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "billing_portal.configuration"
+    end
+  end
+end

data/lib/stripe/resources/billing_portal/session.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module BillingPortal
+    class Session < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "billing_portal.session"
+    end
+  end
+end

data/lib/stripe/{bitcoin_receiver.rb → resources/bitcoin_receiver.rb}

@@ -1,18 +1,20 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
 module Stripe
+  # Directly creating or retrieving BitcoinReceivers is deprecated. Please use
+  # the Sources API instead: https://stripe.com/docs/sources/bitcoin
   class BitcoinReceiver < APIResource
-    extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Save
-    include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'bitcoin_receiver'
+    OBJECT_NAME = "bitcoin_receiver"
 
     def self.resource_url
       "/v1/bitcoin/receivers"
     end
 
     def resource_url
-      if respond_to?(:customer) && !self.customer.nil? && self.customer != ""
+      if respond_to?(:customer) && !customer.nil? && customer != ""
         "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
       else
         "#{self.class.resource_url}/#{CGI.escape(id)}"

data/lib/stripe/resources/bitcoin_transaction.rb

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Directly retrieving BitcoinTransactions is deprecated. Please use
+  # the Sources API instead: https://stripe.com/docs/sources/bitcoin
+  class BitcoinTransaction < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "bitcoin_transaction"
+
+    def self.resource_url
+      "/v1/bitcoin/transactions"
+    end
+  end
+end

data/lib/stripe/resources/capability.rb

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Capability < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "capability"
+
+    def resource_url
+      if !respond_to?(:account) || account.nil?
+        raise NotImplementedError,
+              "Capabilities cannot be accessed without an account ID."
+      end
+      "#{Account.resource_url}/#{CGI.escape(account)}/capabilities" \
+      "/#{CGI.escape(id)}"
+    end
+
+    def self.retrieve(_id, _opts = {})
+      raise NotImplementedError,
+            "Capabilities cannot be retrieve without an account ID. " \
+            "Retrieve a capability using Account.retrieve_capability(" \
+            "'account_id', 'capability_id')`"
+    end
+
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError,
+            "Capabilities cannot be updated without an account ID. Update a " \
+            "capability using `Account.update_capability('account_id', " \
+            "'capability_id', update_params)`"
+    end
+  end
+end

data/lib/stripe/resources/card.rb

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Card < APIResource
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "card"
+
+    def resource_url
+      if respond_to?(:recipient) && !recipient.nil? && !recipient.empty?
+        "#{Recipient.resource_url}/#{CGI.escape(recipient)}/cards/#{CGI.escape(id)}"
+      elsif respond_to?(:customer) && !customer.nil? && !customer.empty?
+        "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
+      elsif respond_to?(:account) && !account.nil? && !account.empty?
+        "#{Account.resource_url}/#{CGI.escape(account)}/external_accounts/#{CGI.escape(id)}"
+      end
+    end
+
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError,
+            "Card cannot be updated without a customer ID or an account ID. " \
+            "Update a card using `Customer.update_source('customer_id', " \
+            "'card_id', update_params)` or `Account.update_external_account(" \
+            "'account_id', 'card_id', update_params)`"
+    end
+
+    def self.retrieve(_id, _opts = nil)
+      raise NotImplementedError,
+            "Card cannot be retrieved without a customer ID or an account " \
+            "ID. Retrieve a card using `Customer.retrieve_source(" \
+            "'customer_id', 'card_id')` or " \
+            "`Account.retrieve_external_account('account_id', 'card_id')`"
+    end
+  end
+end

data/lib/stripe/resources/charge.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Charge < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "charge"
+
+    custom_method :capture, http_verb: :post
+
+    def capture(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/capture",
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/checkout/session.rb

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Checkout
+    class Session < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      extend Stripe::APIOperations::NestedResource
+
+      OBJECT_NAME = "checkout.session"
+
+      nested_resource_class_methods :line_item, operations: %i[list]
+    end
+  end
+end

data/lib/stripe/resources/country_spec.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CountrySpec < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "country_spec"
+  end
+end

data/lib/stripe/{coupon.rb → resources/coupon.rb}

@@ -1,10 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
 module Stripe
   class Coupon < APIResource
     extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
-    OBJECT_NAME = 'coupon'
+    OBJECT_NAME = "coupon"
   end
 end

data/lib/stripe/resources/credit_note.rb

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNote < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "credit_note"
+
+    custom_method :void_credit_note, http_verb: :post, http_path: "void"
+
+    def void_credit_note(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/void",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.preview(params, opts = {})
+      resp, opts = execute_resource_request(:get, resource_url + "/preview", params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
+    end
+
+    def self.list_preview_line_items(params, opts = {})
+      resp, opts = execute_resource_request(:get, resource_url + "/preview/lines", params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
+    end
+  end
+end

data/lib/stripe/resources/credit_note_line_item.rb

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteLineItem < StripeObject
+    OBJECT_NAME = "credit_note_line_item"
+  end
+end

data/lib/stripe/resources/customer.rb

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Customer < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
+
+    OBJECT_NAME = "customer"
+
+    nested_resource_class_methods :balance_transaction,
+                                  operations: %i[create retrieve update list]
+    nested_resource_class_methods :tax_id,
+                                  operations: %i[create retrieve delete list]
+
+    custom_method :delete_discount, http_verb: :delete, http_path: "discount"
+
+    save_nested_resource :source
+    nested_resource_class_methods :source,
+                                  operations: %i[create retrieve update delete list]
+
+    # The API request for deleting a card or bank account and for detaching a
+    # source object are the same.
+    class << self
+      alias detach_source delete_source
+    end
+
+    # Deletes a discount associated with the customer.
+    #
+    # Returns the deleted discount. The customer object is not updated,
+    # so you must call `refresh` on it to get a new version with the
+    # discount removed.
+    def delete_discount
+      resp, opts = execute_resource_request(:delete, resource_url + "/discount")
+      Util.convert_to_stripe_object(resp.data, opts)
+    end
+  end
+end