stripe 1.27.2 → 5.33.0

data/lib/stripe/resources.rb

@@ -0,0 +1,87 @@
+# 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/billing_portal/configuration"
+require "stripe/resources/billing_portal/session"
+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/credit_note_line_item"
+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/identity/verification_report"
+require "stripe/resources/identity/verification_session"
+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/line_item"
+require "stripe/resources/login_link"
+require "stripe/resources/mandate"
+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/price"
+require "stripe/resources/product"
+require "stripe/resources/promotion_code"
+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_attempt"
+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/resources/account.rb

@@ -0,0 +1,170 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Account < APIResource
+    extend Gem::Deprecate
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
+
+    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]
+
+    def resource_url
+      if self["id"]
+        super
+      else
+        "/v1/account"
+      end
+    end
+
+    # @override To make id optional
+    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.
+        opts = id
+        id = nil
+      end
+      super(id, opts)
+    end
+
+    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
+    # rather than an array. So instead of this:
+    #
+    #     field[]=item1&field[]=item2&field[]=item3
+    #
+    # We send this:
+    #
+    #     field[0]=item1&field[1]=item2&field[2]=item3
+    #
+    # There are two major problems with this technique:
+    #
+    #     * Entities are addressed by array index, which is not stable and can
+    #       easily result in unexpected results between two different requests.
+    #
+    #     * A replacement of the array's contents is ambiguous with setting a
+    #       subset of the array. Because of this, the only way to shorten an
+    #       array is to unset it completely by making sure it goes into the
+    #       server as an empty string, then setting its contents again.
+    #
+    # 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, options)
+    end
+
+    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
+
+    def self.protected_fields
+      [:legal_entity]
+    end
+
+    def legal_entity
+      self["legal_entity"]
+    end
+
+    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 = {})
+      params = {
+        client_id: client_id,
+        stripe_user_id: id,
+      }
+      opts = @opts.merge(Util.normalize_opts(opts))
+      OAuth.deauthorize(params, opts)
+    end
+
+    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"
+      end
+
+      update_hash = {}
+      additional_owners.each_with_index do |v, i|
+        # We will almost always see a StripeObject except in the case of a Hash
+        # that's been appended to an array of `additional_owners`. We may be
+        # able to normalize that ugliness by using an array proxy object with
+        # StripeObjects that can detect appends and replace a hash with a
+        # StripeObject.
+        update = v.is_a?(StripeObject) ? v.serialize_params : v
+
+        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
+  end
+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/resources/apple_pay_domain.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Domains registered for Apple Pay on the Web
+  class ApplePayDomain < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "apple_pay_domain"
+
+    def self.resource_url
+      "/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,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/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