stripe 3.8.2 → 5.45.0

data/lib/stripe/resources/person.rb

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Person < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "person"
+
+    def resource_url
+      if !respond_to?(:account) || account.nil?
+        raise NotImplementedError,
+              "Persons cannot be accessed without an account ID."
+      end
+      "#{Account.resource_url}/#{CGI.escape(account)}/persons/#{CGI.escape(id)}"
+    end
+
+    def self.retrieve(_id, _opts = {})
+      raise NotImplementedError,
+            "Persons cannot be retrieved without an account ID. Retrieve a " \
+            "person using `Account.retrieve_person('account_id', 'person_id')`"
+    end
+
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError,
+            "Persons cannot be updated without an account ID. Update a " \
+            "person using `Account.update_person('account_id', 'person_id', " \
+            "update_params)`"
+    end
+  end
+end

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

@@ -1,3 +1,6 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
 module Stripe
   class Plan < APIResource
     extend Stripe::APIOperations::Create
@@ -5,6 +8,6 @@ module Stripe
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "plan".freeze
+    OBJECT_NAME = "plan"
   end
 end

data/lib/stripe/resources/price.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Price < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "price"
+  end
+end

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

@@ -1,10 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
 module Stripe
   class Product < APIResource
-    extend Stripe::APIOperations::List
     extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "product".freeze
+    OBJECT_NAME = "product"
   end
 end

data/lib/stripe/resources/promotion_code.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PromotionCode < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "promotion_code"
+  end
+end

data/lib/stripe/resources/quote.rb

@@ -0,0 +1,105 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Quote < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "quote"
+
+    custom_method :accept, http_verb: :post
+    custom_method :cancel, http_verb: :post
+    custom_method :finalize_quote, http_verb: :post, http_path: "finalize"
+    custom_method :list_computed_upfront_line_items, http_verb: :get, http_path: "computed_upfront_line_items"
+    custom_method :list_line_items, http_verb: :get, http_path: "line_items"
+
+    def accept(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/accept",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def cancel(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def finalize_quote(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/finalize",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def list_computed_upfront_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: resource_url + "/computed_upfront_line_items",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def list_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: resource_url + "/line_items",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def pdf(params = {}, opts = {}, &read_body_chunk_block)
+      unless block_given?
+        raise ArgumentError, "A read_body_chunk_block block parameter is required when calling the pdf method."
+      end
+
+      config = opts[:client]&.config || Stripe.config
+
+      request_stream(
+        method: :get,
+        path: resource_url + "/pdf",
+        params: params,
+        opts: {
+          api_base: config.uploads_base,
+        }.merge(opts),
+        &read_body_chunk_block
+      )
+    end
+
+    def self.pdf(id, params = {}, opts = {}, &read_body_chunk_block)
+      unless id.is_a?(String)
+        raise ArgumentError,
+              "id should be a string representing the ID of an API resource"
+      end
+
+      unless block_given?
+        raise ArgumentError, "A read_body_chunk_block block parameter is required when calling the pdf method."
+      end
+
+      config = opts[:client]&.config || Stripe.config
+
+      resp = execute_resource_request_stream(
+        :get,
+        "#{resource_url}/#{CGI.escape(id)}/pdf",
+        params,
+        {
+          api_base: config.uploads_base,
+        }.merge(opts),
+        &read_body_chunk_block
+      )
+      resp
+    end
+  end
+end

data/lib/stripe/resources/radar/early_fraud_warning.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Radar
+    class EarlyFraudWarning < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "radar.early_fraud_warning"
+    end
+  end
+end

data/lib/stripe/resources/radar/value_list.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Radar
+    class ValueList < APIResource
+      extend Stripe::APIOperations::Create
+      include Stripe::APIOperations::Delete
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "radar.value_list"
+    end
+  end
+end

data/lib/stripe/resources/radar/value_list_item.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Radar
+    class ValueListItem < APIResource
+      extend Stripe::APIOperations::Create
+      include Stripe::APIOperations::Delete
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "radar.value_list_item"
+    end
+  end
+end

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

@@ -1,15 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
 module Stripe
   # Recipients objects are deprecated. Please use Stripe Connect instead.
   class Recipient < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "recipient".freeze
-
-    def transfers
-      Transfer.all({ recipient: id }, @api_key)
-    end
+    OBJECT_NAME = "recipient"
   end
 end

data/lib/stripe/resources/recipient_transfer.rb

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

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

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

data/lib/stripe/resources/reporting/report_run.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Reporting
+    class ReportRun < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "reporting.report_run"
+    end
+  end
+end

data/lib/stripe/resources/reporting/report_type.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Reporting
+    class ReportType < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "reporting.report_type"
+    end
+  end
+end

data/lib/stripe/resources/reversal.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Reversal < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "transfer_reversal"
+
+    def resource_url
+      "#{Transfer.resource_url}/#{CGI.escape(transfer)}/reversals" \
+      "/#{CGI.escape(id)}"
+    end
+
+    def self.update(_id, _params = nil, _opts = nil)
+      raise NotImplementedError,
+            "Reversals cannot be updated without a transfer ID. Update a " \
+            "reversal using `r = Transfer.update_reversal('transfer_id', " \
+            "'reversal_id', update_params)`"
+    end
+
+    def self.retrieve(_id, _opts = {})
+      raise NotImplementedError,
+            "Reversals cannot be retrieved without a transfer ID. Retrieve " \
+            "a reversal using `Transfer.retrieve_reversal('transfer_id', " \
+            "'reversal_id'`"
+    end
+  end
+end

data/lib/stripe/resources/review.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Review < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "review"
+
+    custom_method :approve, http_verb: :post
+
+    def approve(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/approve",
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/setup_attempt.rb

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

data/lib/stripe/resources/setup_intent.rb

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SetupIntent < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "setup_intent"
+
+    custom_method :cancel, http_verb: :post
+    custom_method :confirm, http_verb: :post
+    custom_method :verify_microdeposits, http_verb: :post
+
+    def cancel(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def confirm(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/confirm",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def verify_microdeposits(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/verify_microdeposits",
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/shipping_rate.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ShippingRate < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "shipping_rate"
+  end
+end

data/lib/stripe/resources/sigma/scheduled_query_run.rb

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Sigma
+    class ScheduledQueryRun < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "scheduled_query_run"
+
+      def self.resource_url
+        "/v1/sigma/scheduled_query_runs"
+      end
+    end
+  end
+end

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

@@ -1,10 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
 module Stripe
   class SKU < APIResource
-    extend Stripe::APIOperations::List
     extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "sku".freeze
+    OBJECT_NAME = "sku"
   end
 end

data/lib/stripe/resources/source.rb

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Source < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
+
+    OBJECT_NAME = "source"
+
+    custom_method :verify, http_verb: :post
+
+    nested_resource_class_methods :source_transaction,
+                                  operations: %i[retrieve list]
+
+    def verify(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/verify",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def detach(params = {}, opts = {})
+      if !respond_to?(:customer) || customer.nil? || customer.empty?
+        raise NotImplementedError,
+              "This source object does not appear to be currently attached " \
+              "to a customer object."
+      end
+
+      url = "#{Customer.resource_url}/#{CGI.escape(customer)}/sources" \
+            "/#{CGI.escape(id)}"
+      resp, opts = execute_resource_request(:delete, url, params, opts)
+      initialize_from(resp.data, opts)
+    end
+
+    def source_transactions(params = {}, opts = {})
+      resp, opts = execute_resource_request(:get, resource_url + "/source_transactions", params,
+                                            opts)
+      Util.convert_to_stripe_object(resp.data, opts)
+    end
+    extend Gem::Deprecate
+    deprecate :source_transactions, :"Source.list_source_transactions", 2020, 1
+  end
+end

data/lib/stripe/resources/source_transaction.rb

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

data/lib/stripe/resources/subscription.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class Subscription < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "subscription"
+
+    custom_method :delete_discount, http_verb: :delete, http_path: "discount"
+
+    def delete_discount(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: resource_url + "/discount",
+        params: params,
+        opts: opts
+      )
+    end
+
+    save_nested_resource :source
+  end
+end

data/lib/stripe/resources/subscription_item.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SubscriptionItem < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
+
+    OBJECT_NAME = "subscription_item"
+
+    nested_resource_class_methods :usage_record, operations: %i[create]
+    nested_resource_class_methods :usage_record_summary,
+                                  operations: %i[list],
+                                  resource_plural: "usage_record_summaries"
+
+    def usage_record_summaries(params = {}, opts = {})
+      resp, opts = execute_resource_request(:get, resource_url + "/usage_record_summaries", params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
+    end
+    extend Gem::Deprecate
+    deprecate :usage_record_summaries, :"SubscriptionItem.list_usage_record_summaries", 2020, 1
+  end
+end

data/lib/stripe/resources/subscription_schedule.rb

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

data/lib/stripe/resources/tax_code.rb

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

data/lib/stripe/resources/tax_id.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TaxId < APIResource
+    include Stripe::APIOperations::Delete
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "tax_id"
+
+    def resource_url
+      if !respond_to?(:customer) || customer.nil?
+        raise NotImplementedError,
+              "Tax IDs cannot be accessed without a customer ID."
+      end
+      "#{Customer.resource_url}/#{CGI.escape(customer)}/tax_ids" \
+      "/#{CGI.escape(id)}"
+    end
+
+    def self.retrieve(_id, _opts = {})
+      raise NotImplementedError,
+            "Tax IDs cannot be retrieved without a customer ID. Retrieve a " \
+            "tax ID using `Customer.retrieve_tax_id('customer_id', " \
+            "'tax_id_id')`"
+    end
+  end
+end

data/lib/stripe/resources/tax_rate.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TaxRate < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "tax_rate"
+  end
+end