stripe 4.9.0 → 5.1.0

data/lib/stripe/object_types.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/MethodLength
+
+module Stripe
+  module ObjectTypes
+    def self.object_names_to_classes
+      {
+        # data structures
+        ListObject::OBJECT_NAME => ListObject,
+
+        # business objects
+        Account::OBJECT_NAME => Account,
+        AccountLink::OBJECT_NAME => AccountLink,
+        AlipayAccount::OBJECT_NAME => AlipayAccount,
+        ApplePayDomain::OBJECT_NAME => ApplePayDomain,
+        ApplicationFee::OBJECT_NAME => ApplicationFee,
+        ApplicationFeeRefund::OBJECT_NAME => ApplicationFeeRefund,
+        Balance::OBJECT_NAME => Balance,
+        BalanceTransaction::OBJECT_NAME => BalanceTransaction,
+        BankAccount::OBJECT_NAME => BankAccount,
+        BitcoinReceiver::OBJECT_NAME => BitcoinReceiver,
+        BitcoinTransaction::OBJECT_NAME => BitcoinTransaction,
+        Capability::OBJECT_NAME => Capability,
+        Card::OBJECT_NAME => Card,
+        Charge::OBJECT_NAME => Charge,
+        Checkout::Session::OBJECT_NAME => Checkout::Session,
+        CountrySpec::OBJECT_NAME => CountrySpec,
+        Coupon::OBJECT_NAME => Coupon,
+        CreditNote::OBJECT_NAME => CreditNote,
+        Customer::OBJECT_NAME => Customer,
+        CustomerBalanceTransaction::OBJECT_NAME => CustomerBalanceTransaction,
+        Discount::OBJECT_NAME => Discount,
+        Dispute::OBJECT_NAME => Dispute,
+        EphemeralKey::OBJECT_NAME => EphemeralKey,
+        Event::OBJECT_NAME => Event,
+        ExchangeRate::OBJECT_NAME => ExchangeRate,
+        File::OBJECT_NAME => File,
+        File::OBJECT_NAME_ALT => File,
+        FileLink::OBJECT_NAME => FileLink,
+        Invoice::OBJECT_NAME => Invoice,
+        InvoiceItem::OBJECT_NAME => InvoiceItem,
+        InvoiceLineItem::OBJECT_NAME => InvoiceLineItem,
+        Issuing::Authorization::OBJECT_NAME => Issuing::Authorization,
+        Issuing::Card::OBJECT_NAME => Issuing::Card,
+        Issuing::CardDetails::OBJECT_NAME => Issuing::CardDetails,
+        Issuing::Cardholder::OBJECT_NAME => Issuing::Cardholder,
+        Issuing::Dispute::OBJECT_NAME => Issuing::Dispute,
+        Issuing::Transaction::OBJECT_NAME => Issuing::Transaction,
+        LoginLink::OBJECT_NAME => LoginLink,
+        Order::OBJECT_NAME => Order,
+        OrderReturn::OBJECT_NAME => OrderReturn,
+        PaymentIntent::OBJECT_NAME => PaymentIntent,
+        PaymentMethod::OBJECT_NAME => PaymentMethod,
+        Payout::OBJECT_NAME => Payout,
+        Person::OBJECT_NAME => Person,
+        Plan::OBJECT_NAME => Plan,
+        Product::OBJECT_NAME => Product,
+        Radar::EarlyFraudWarning::OBJECT_NAME => Radar::EarlyFraudWarning,
+        Radar::ValueList::OBJECT_NAME => Radar::ValueList,
+        Radar::ValueListItem::OBJECT_NAME => Radar::ValueListItem,
+        Recipient::OBJECT_NAME => Recipient,
+        RecipientTransfer::OBJECT_NAME => RecipientTransfer,
+        Refund::OBJECT_NAME => Refund,
+        Reporting::ReportRun::OBJECT_NAME => Reporting::ReportRun,
+        Reporting::ReportType::OBJECT_NAME => Reporting::ReportType,
+        Reversal::OBJECT_NAME => Reversal,
+        Review::OBJECT_NAME => Review,
+        SKU::OBJECT_NAME => SKU,
+        SetupIntent::OBJECT_NAME => SetupIntent,
+        Sigma::ScheduledQueryRun::OBJECT_NAME => Sigma::ScheduledQueryRun,
+        Source::OBJECT_NAME => Source,
+        SourceTransaction::OBJECT_NAME => SourceTransaction,
+        Subscription::OBJECT_NAME => Subscription,
+        SubscriptionItem::OBJECT_NAME => SubscriptionItem,
+        SubscriptionSchedule::OBJECT_NAME => SubscriptionSchedule,
+        TaxId::OBJECT_NAME => TaxId,
+        TaxRate::OBJECT_NAME => TaxRate,
+        Terminal::ConnectionToken::OBJECT_NAME => Terminal::ConnectionToken,
+        Terminal::Location::OBJECT_NAME => Terminal::Location,
+        Terminal::Reader::OBJECT_NAME => Terminal::Reader,
+        ThreeDSecure::OBJECT_NAME => ThreeDSecure,
+        Token::OBJECT_NAME => Token,
+        Topup::OBJECT_NAME => Topup,
+        Transfer::OBJECT_NAME => Transfer,
+        UsageRecord::OBJECT_NAME => UsageRecord,
+        UsageRecordSummary::OBJECT_NAME => UsageRecordSummary,
+        WebhookEndpoint::OBJECT_NAME => WebhookEndpoint,
+      }
+    end
+  end
+end
+
+# rubocop:enable Metrics/MethodLength

data/lib/stripe/resources.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "stripe/resources/account"
+require "stripe/resources/account_link"
+require "stripe/resources/alipay_account"
+require "stripe/resources/apple_pay_domain"
+require "stripe/resources/application_fee"
+require "stripe/resources/application_fee_refund"
+require "stripe/resources/balance"
+require "stripe/resources/balance_transaction"
+require "stripe/resources/bank_account"
+require "stripe/resources/bitcoin_receiver"
+require "stripe/resources/bitcoin_transaction"
+require "stripe/resources/capability"
+require "stripe/resources/card"
+require "stripe/resources/charge"
+require "stripe/resources/checkout/session"
+require "stripe/resources/country_spec"
+require "stripe/resources/coupon"
+require "stripe/resources/credit_note"
+require "stripe/resources/customer"
+require "stripe/resources/customer_balance_transaction"
+require "stripe/resources/discount"
+require "stripe/resources/dispute"
+require "stripe/resources/ephemeral_key"
+require "stripe/resources/event"
+require "stripe/resources/exchange_rate"
+require "stripe/resources/file"
+require "stripe/resources/file_link"
+require "stripe/resources/invoice"
+require "stripe/resources/invoice_item"
+require "stripe/resources/invoice_line_item"
+require "stripe/resources/issuing/authorization"
+require "stripe/resources/issuing/card"
+require "stripe/resources/issuing/card_details"
+require "stripe/resources/issuing/cardholder"
+require "stripe/resources/issuing/dispute"
+require "stripe/resources/issuing/transaction"
+require "stripe/resources/login_link"
+require "stripe/resources/order"
+require "stripe/resources/order_return"
+require "stripe/resources/payment_intent"
+require "stripe/resources/payment_method"
+require "stripe/resources/payout"
+require "stripe/resources/person"
+require "stripe/resources/plan"
+require "stripe/resources/product"
+require "stripe/resources/radar/early_fraud_warning"
+require "stripe/resources/radar/value_list"
+require "stripe/resources/radar/value_list_item"
+require "stripe/resources/recipient"
+require "stripe/resources/recipient_transfer"
+require "stripe/resources/refund"
+require "stripe/resources/reporting/report_run"
+require "stripe/resources/reporting/report_type"
+require "stripe/resources/reversal"
+require "stripe/resources/review"
+require "stripe/resources/setup_intent"
+require "stripe/resources/sigma/scheduled_query_run"
+require "stripe/resources/sku"
+require "stripe/resources/source"
+require "stripe/resources/source_transaction"
+require "stripe/resources/subscription"
+require "stripe/resources/subscription_item"
+require "stripe/resources/subscription_schedule"
+require "stripe/resources/tax_id"
+require "stripe/resources/tax_rate"
+require "stripe/resources/terminal/connection_token"
+require "stripe/resources/terminal/location"
+require "stripe/resources/terminal/reader"
+require "stripe/resources/three_d_secure"
+require "stripe/resources/token"
+require "stripe/resources/topup"
+require "stripe/resources/transfer"
+require "stripe/resources/usage_record"
+require "stripe/resources/usage_record_summary"
+require "stripe/resources/webhook_endpoint"

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

@@ -4,23 +4,36 @@ 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".freeze
+    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
+
     nested_resource_class_methods :external_account,
                                   operations: %i[create retrieve update delete list]
-    nested_resource_class_methods :login_link, operations: %i[create]
-    nested_resource_class_methods :person,
-                                  operations: %i[create retrieve update delete list]
 
-    # 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 :login_link, operations: %i[create]
 
     def resource_url
       if self["id"]
@@ -32,13 +45,18 @@ module Stripe
 
     # @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)
+      id = if id.equal?(ARGUMENT_NOT_PROVIDED)
+             nil
+           else
+             Util.check_string_argument!(id)
+           end
 
       # 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.
+        # `super` properly assumes a String opts is the apiKey and normalizes
+        # as expected.
         opts = id
         id = nil
       end
@@ -46,15 +64,13 @@ module Stripe
     end
 
     def persons(params = {}, opts = {})
-      resp, opts = request(:get, resource_url + "/persons", params, Util.normalize_opts(opts))
+      resp, opts = request(:get, resource_url + "/persons", params, opts)
       Util.convert_to_stripe_object(resp.data, 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)
-    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,
@@ -107,8 +123,11 @@ module Stripe
       self["legal_entity"]
     end
 
-    def legal_entity=(_)
-      raise NoMethodError, 'Overriding 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 = {})
@@ -121,15 +140,17 @@ module Stripe
 
     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, "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 = {}
@@ -141,10 +162,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/{account_link.rb → resources/account_link.rb}

@@ -4,6 +4,6 @@ module Stripe
   class AccountLink < APIResource
     extend Stripe::APIOperations::Create
 
-    OBJECT_NAME = "account_link".freeze
+    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}

@@ -7,7 +7,7 @@ module Stripe
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "apple_pay_domain".freeze
+    OBJECT_NAME = "apple_pay_domain"
 
     def self.resource_url
       "/v1/apple_pay/domains"

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}

@@ -2,6 +2,6 @@
 
 module Stripe
   class Balance < SingletonAPIResource
-    OBJECT_NAME = "balance".freeze
+    OBJECT_NAME = "balance"
   end
 end

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

@@ -4,10 +4,6 @@ module Stripe
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "balance_transaction".freeze
-
-    def self.resource_url
-      "/v1/balance/history"
-    end
+    OBJECT_NAME = "balance_transaction"
   end
 end

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

@@ -2,11 +2,11 @@
 
 module Stripe
   class BankAccount < APIResource
-    include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "bank_account".freeze
+    OBJECT_NAME = "bank_account"
 
     def verify(params = {}, opts = {})
       resp, opts = request(:post, resource_url + "/verify", params, opts)
@@ -22,11 +22,21 @@ module Stripe
     end
 
     def self.update(_id, _params = nil, _opts = nil)
-      raise NotImplementedError, "Bank accounts cannot be updated without an account ID. Update a bank account by using `a = account.external_accounts.retrieve('card_id'); a.save`"
+      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 retrieved without an account ID. Retrieve a bank account using account.external_accounts.retrieve('card_id')"
+      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