stripe 4.10.0 → 5.55.0

data/lib/stripe/resources/customer.rb

@@ -0,0 +1,74 @@
+# 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
+    extend Stripe::APIOperations::Search
+    include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
+
+    OBJECT_NAME = "customer"
+
+    custom_method :create_funding_instructions, http_verb: :post, http_path: "funding_instructions"
+    custom_method :list_payment_methods, http_verb: :get, http_path: "payment_methods"
+
+    nested_resource_class_methods :cash_balance,
+                                  operations: %i[retrieve update],
+                                  resource_plural: "cash_balance"
+    nested_resource_class_methods :balance_transaction,
+                                  operations: %i[create retrieve update list]
+    nested_resource_class_methods :tax_id,
+                                  operations: %i[create retrieve delete list]
+
+    def create_funding_instructions(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/funding_instructions",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def list_payment_methods(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: resource_url + "/payment_methods",
+        params: params,
+        opts: opts
+      )
+    end
+
+    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
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/customers/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
+  end
+end

data/lib/stripe/resources/customer_balance_transaction.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# 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,8 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Discount < StripeObject
+    OBJECT_NAME = "discount"
+  end
+end

data/lib/stripe/resources/dispute.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# 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/{ephemeral_key.rb → resources/ephemeral_key.rb}

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -5,11 +6,14 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
 
-    OBJECT_NAME = "ephemeral_key".freeze
+    OBJECT_NAME = "ephemeral_key"
 
     def self.create(params = {}, opts = {})
       opts = Util.normalize_opts(opts)
-      raise ArgumentError, "stripe_version must be specified to create an ephemeral key" unless opts[:stripe_version]
+      unless opts[:stripe_version]
+        raise ArgumentError,
+              "stripe_version must be specified to create an ephemeral key"
+      end
       super
     end
   end

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

@@ -1,9 +1,10 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class Event < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "event".freeze
+    OBJECT_NAME = "event"
   end
 end

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

@@ -1,9 +1,10 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class ExchangeRate < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "exchange_rate".freeze
+    OBJECT_NAME = "exchange_rate"
   end
 end

data/lib/stripe/resources/file.rb

@@ -0,0 +1,36 @@
+# File generated from our OpenAPI spec
+# 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
+
+      config = opts[:client]&.config || Stripe.config
+      opts = {
+        api_base: config.uploads_base,
+        content_type: MultipartEncoder::MULTIPART_FORM_DATA,
+      }.merge(Util.normalize_opts(opts))
+      super
+    end
+  end
+end

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

@@ -1,11 +1,12 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class FileLink < APIResource
     extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "file_link".freeze
+    OBJECT_NAME = "file_link"
   end
 end

data/lib/stripe/resources/financial_connections/account.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class Account < APIResource
+      OBJECT_NAME = "financial_connections.account"
+
+      custom_method :disconnect, http_verb: :post
+      custom_method :refresh, http_verb: :post
+
+      def disconnect(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/disconnect",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def refresh(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/refresh",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/financial_connections/account_owner.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountOwner < StripeObject
+      OBJECT_NAME = "financial_connections.account_owner"
+    end
+  end
+end

data/lib/stripe/resources/financial_connections/account_ownership.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountOwnership < StripeObject
+      OBJECT_NAME = "financial_connections.account_ownership"
+    end
+  end
+end

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

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

data/lib/stripe/resources/funding_instructions.rb

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FundingInstructions < APIResource
+    OBJECT_NAME = "funding_instructions"
+
+    def resource_url
+      if !respond_to?(:customer) || customer.nil?
+        raise NotImplementedError,
+              "FundingInstructions cannot be accessed without a customer ID."
+      end
+      "#{Customer.resource_url}/#{CGI.escape(customer)}/funding_instructions" "/#{CGI.escape(id)}"
+    end
+  end
+end

data/lib/stripe/resources/identity/verification_report.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationReport < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "identity.verification_report"
+    end
+  end
+end

data/lib/stripe/resources/identity/verification_session.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationSession < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "identity.verification_session"
+
+      custom_method :cancel, http_verb: :post
+      custom_method :redact, http_verb: :post
+
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/cancel",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def redact(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/redact",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/invoice.rb

@@ -0,0 +1,83 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Invoice < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
+    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 = execute_resource_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 = execute_resource_request(:get, resource_url + "/upcoming/lines", params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
+    end
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/invoices/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
+  end
+end

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

@@ -1,12 +1,13 @@
+# File generated from our OpenAPI spec
 # 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".freeze
+    OBJECT_NAME = "invoiceitem"
   end
 end

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

@@ -1,7 +1,8 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class InvoiceLineItem < StripeObject
-    OBJECT_NAME = "line_item".freeze
+    OBJECT_NAME = "line_item"
   end
 end

data/lib/stripe/resources/issuing/authorization.rb

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class Authorization < APIResource
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "issuing.authorization"
+
+      custom_method :approve, http_verb: :post
+      custom_method :decline, http_verb: :post
+
+      def approve(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/approve",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def decline(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/decline",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/issuing/card.rb

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class Card < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "issuing.card"
+
+      custom_method :details, http_verb: :get
+
+      def details(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: resource_url + "/details",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/issuing/card_details.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class CardDetails < StripeObject
+      OBJECT_NAME = "issuing.card_details"
+    end
+  end
+end

data/lib/stripe/{issuing → resources/issuing}/cardholder.rb

@@ -1,13 +1,14 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   module Issuing
-    class Cardholder < Stripe::APIResource
+    class Cardholder < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save
 
-      OBJECT_NAME = "issuing.cardholder".freeze
+      OBJECT_NAME = "issuing.cardholder"
     end
   end
 end

data/lib/stripe/resources/issuing/dispute.rb

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

data/lib/stripe/{issuing → resources/issuing}/transaction.rb

@@ -1,12 +1,13 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   module Issuing
-    class Transaction < Stripe::APIResource
+    class Transaction < APIResource
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save
 
-      OBJECT_NAME = "issuing.transaction".freeze
+      OBJECT_NAME = "issuing.transaction"
     end
   end
 end

data/lib/stripe/resources/line_item.rb

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

data/lib/stripe/resources/login_link.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class LoginLink < APIResource
+    OBJECT_NAME = "login_link"
+
+    def self.retrieve(_id, _opts = nil)
+      raise NotImplementedError,
+            "Login links do not have IDs and cannot be retrieved. They can " \
+            "only be created using `Account.create_login_link('account_id', " \
+            "create_params)`"
+    end
+  end
+end

data/lib/stripe/resources/mandate.rb

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