stripe 3.2.0 → 5.16.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stripe
   # Domains registered for Apple Pay on the Web
   class ApplePayDomain < APIResource
@@ -5,10 +7,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,13 @@
+# 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,30 @@
+# frozen_string_literal: true
+
+module Stripe
+  class ApplicationFeeRefund < APIResource
+    include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::List
+
+    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/{balance.rb → resources/balance.rb}

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Stripe
   class Balance < SingletonAPIResource
-    OBJECT_NAME = 'balance'
+    OBJECT_NAME = "balance"
   end
 end

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

@@ -1,11 +1,9 @@
+# frozen_string_literal: true
+
 module Stripe
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'balance_transaction'
-
-    def self.resource_url
-      '/v1/balance/history'
-    end
+    OBJECT_NAME = "balance_transaction"
   end
 end

data/lib/stripe/resources/bank_account.rb

@@ -0,0 +1,42 @@
+# 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 = 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/{bitcoin_receiver.rb → resources/bitcoin_receiver.rb}

@@ -1,18 +1,19 @@
+# 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,15 @@
+# frozen_string_literal: true
+
+module Stripe
+  class BitcoinTransaction < APIResource
+    # Directly retrieving BitcoinTransactions is deprecated. Please use the
+    # Sources API instead: https://stripe.com/docs/sources/bitcoin
+    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,33 @@
+# 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,37 @@
+# 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,22 @@
+# 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,12 @@
+# frozen_string_literal: true
+
+module Stripe
+  module Checkout
+    class Session < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "checkout.session"
+    end
+  end
+end

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

@@ -1,11 +1,9 @@
+# frozen_string_literal: true
+
 module Stripe
   class CountrySpec < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'country_spec'
-
-    def self.resource_url
-      '/v1/country_specs'
-    end
+    OBJECT_NAME = "country_spec"
   end
 end

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

@@ -1,10 +1,12 @@
+# 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,32 @@
+# 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 = 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 = 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,7 @@
+# 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,35 @@
+# 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
+
+    def delete_discount
+      resp, opts = request(:delete, resource_url + "/discount")
+      initialize_from(resp.data, opts, true)
+    end
+  end
+end

data/lib/stripe/resources/customer_balance_transaction.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerBalanceTransaction < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "customer_balance_transaction"
+
+    def resource_url
+      if !respond_to?(:customer) || customer.nil?
+        raise NotImplementedError,
+              "Customer Balance Transactions cannot be accessed without a customer ID."
+      end
+      "#{Customer.resource_url}/#{CGI.escape(customer)}/balance_transactions/#{CGI.escape(id)}"
+    end
+
+    def self.retrieve(_id, _opts = {})
+      raise NotImplementedError,
+            "Customer Balance Transactions cannot be retrieved without a customer ID. " \
+            "Retrieve a Customer Balance Transaction using Customer.retrieve_balance_transaction('cus_123', 'cbtxn_123')"
+    end
+
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError,
+            "Customer Balance Transactions cannot be retrieved without a customer ID. " \
+            "Update a Customer Balance Transaction using Customer.update_balance_transaction('cus_123', 'cbtxn_123', params)"
+    end
+  end
+end

data/lib/stripe/resources/discount.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stripe
+  class Discount < StripeObject
+    OBJECT_NAME = "discount"
+  end
+end

data/lib/stripe/resources/dispute.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Stripe
+  class Dispute < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "dispute"
+
+    custom_method :close, http_verb: :post
+
+    def close(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/close",
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/ephemeral_key.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Stripe
+  class EphemeralKey < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+
+    OBJECT_NAME = "ephemeral_key"
+
+    def self.create(params = {}, opts = {})
+      opts = Util.normalize_opts(opts)
+      unless opts[:stripe_version]
+        raise ArgumentError,
+              "stripe_version must be specified to create an ephemeral key"
+      end
+      super
+    end
+  end
+end

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Stripe
   class Event < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = 'event'
+    OBJECT_NAME = "event"
   end
 end

data/lib/stripe/resources/exchange_rate.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Stripe
+  class ExchangeRate < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "exchange_rate"
+  end
+end

data/lib/stripe/resources/file.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Stripe
+  class File < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "file"
+
+    # This resource can have two different object names. In latter API
+    # versions, only `file` is used, but since stripe-ruby may be used with
+    # any API version, we need to support deserializing the older
+    # `file_upload` object into the same class.
+    OBJECT_NAME_ALT = "file_upload"
+
+    def self.resource_url
+      "/v1/files"
+    end
+
+    def self.create(params = {}, opts = {})
+      if params[:file] && !params[:file].is_a?(String)
+        unless params[:file].respond_to?(:read)
+          raise ArgumentError, "file must respond to `#read`"
+        end
+      end
+
+      opts = {
+        api_base: Stripe.uploads_base,
+        content_type: MultipartEncoder::MULTIPART_FORM_DATA,
+      }.merge(Util.normalize_opts(opts))
+      super
+    end
+  end
+end

data/lib/stripe/resources/file_link.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Stripe
+  class FileLink < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "file_link"
+  end
+end

data/lib/stripe/resources/invoice.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Stripe
+  class Invoice < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "invoice"
+
+    custom_method :finalize_invoice, http_verb: :post, http_path: "finalize"
+    custom_method :mark_uncollectible, http_verb: :post
+    custom_method :pay, http_verb: :post
+    custom_method :send_invoice, http_verb: :post, http_path: "send"
+    custom_method :void_invoice, http_verb: :post, http_path: "void"
+
+    def finalize_invoice(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/finalize",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def mark_uncollectible(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/mark_uncollectible",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def pay(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/pay",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def send_invoice(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/send",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def void_invoice(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/void",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.upcoming(params, opts = {})
+      resp, opts = request(:get, resource_url + "/upcoming", params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
+    end
+
+    def self.list_upcoming_line_items(params, opts = {})
+      resp, opts = request(:get, resource_url + "/upcoming/lines", params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
+    end
+  end
+end

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Stripe
   class InvoiceItem < APIResource
-    extend Stripe::APIOperations::List
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = 'invoiceitem'
+    OBJECT_NAME = "invoiceitem"
   end
 end

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Stripe
   class InvoiceLineItem < StripeObject
-    OBJECT_NAME = 'line_item'
+    OBJECT_NAME = "line_item"
   end
 end