stripe 1.27.2 → 5.33.0

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/resources/bitcoin_receiver.rb

@@ -0,0 +1,24 @@
+# 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::List
+
+    OBJECT_NAME = "bitcoin_receiver"
+
+    def self.resource_url
+      "/v1/bitcoin/receivers"
+    end
+
+    def resource_url
+      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)}"
+      end
+    end
+  end
+end

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,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/resources/coupon.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Coupon < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    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,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,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

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,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/resources/ephemeral_key.rb

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec
+# 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/resources/event.rb

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

data/lib/stripe/resources/exchange_rate.rb

@@ -0,0 +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"
+  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/resources/file_link.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# 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