stripe 10.11.0 → 10.12.0.pre.beta.1

data/lib/stripe/resources/subscription_schedule.rb

@@ -15,41 +15,41 @@ module Stripe
       "subscription_schedule"
     end
 
-    # Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
-    def cancel(params = {}, opts = {})
+    # Amends an existing subscription schedule.
+    def amend(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(self["id"]) }),
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
     end
 
-    # Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
-    def release(params = {}, opts = {})
+    # Amends an existing subscription schedule.
+    def self.amend(schedule, params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(self["id"]) }),
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
         params: params,
         opts: opts
       )
     end
 
     # Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
-    def self.cancel(schedule, params = {}, opts = {})
+    def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(schedule) }),
+        path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
     end
 
-    # Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
-    def self.release(schedule, params = {}, opts = {})
+    # Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
+    def self.cancel(schedule, params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(schedule) }),
+        path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(schedule) }),
         params: params,
         opts: opts
       )
@@ -75,6 +75,26 @@ module Stripe
       )
     end
 
+    # Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
+    def release(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
+    def self.release(schedule, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # Updates an existing subscription schedule.
     def self.update(id, params = {}, opts = {})
       request_stripe_object(

data/lib/stripe/resources/tax/calculation.rb

@@ -14,31 +14,31 @@ module Stripe
         "tax.calculation"
       end
 
-      # Retrieves the line items of a persisted tax calculation as a collection.
-      def list_line_items(params = {}, opts = {})
+      # Calculates tax based on input and returns a Tax Calculation object.
+      def self.create(params = {}, opts = {})
         request_stripe_object(
-          method: :get,
-          path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(self["id"]) }),
+          method: :post,
+          path: "/v1/tax/calculations",
           params: params,
           opts: opts
         )
       end
 
       # Retrieves the line items of a persisted tax calculation as a collection.
-      def self.list_line_items(calculation, params = {}, opts = {})
+      def list_line_items(params = {}, opts = {})
         request_stripe_object(
           method: :get,
-          path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(calculation) }),
+          path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      # Calculates tax based on input and returns a Tax Calculation object.
-      def self.create(params = {}, opts = {})
+      # Retrieves the line items of a persisted tax calculation as a collection.
+      def self.list_line_items(calculation, params = {}, opts = {})
         request_stripe_object(
-          method: :post,
-          path: "/v1/tax/calculations",
+          method: :get,
+          path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(calculation) }),
           params: params,
           opts: opts
         )

data/lib/stripe/resources/tax/form.rb

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.
+    #
+    # Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
+    class Form < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "tax.form"
+      def self.object_name
+        "tax.form"
+      end
+
+      # Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(method: :get, path: "/v1/tax/forms", params: filters, opts: opts)
+      end
+
+      # Download the PDF for a tax form.
+      def pdf(params = {}, opts = {}, &read_body_chunk_block)
+        config = opts[:client]&.config || Stripe.config
+        opts = { api_base: config.uploads_base }.merge(opts)
+        request_stream(
+          method: :get,
+          path: format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts,
+          &read_body_chunk_block
+        )
+      end
+
+      # Download the PDF for a tax form.
+      def self.pdf(id, params = {}, opts = {}, &read_body_chunk_block)
+        config = opts[:client]&.config || Stripe.config
+        opts = { api_base: config.uploads_base }.merge(opts)
+        execute_resource_request_stream(
+          :get,
+          format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(id) }),
+          params,
+          opts,
+          &read_body_chunk_block
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/tax/transaction.rb

@@ -12,16 +12,6 @@ module Stripe
         "tax.transaction"
       end
 
-      # Retrieves the line items of a committed standalone transaction as a collection.
-      def list_line_items(params = {}, opts = {})
-        request_stripe_object(
-          method: :get,
-          path: format("/v1/tax/transactions/%<transaction>s/line_items", { transaction: CGI.escape(self["id"]) }),
-          params: params,
-          opts: opts
-        )
-      end
-
       # Creates a Tax Transaction from a calculation.
       def self.create_from_calculation(params = {}, opts = {})
         request_stripe_object(
@@ -42,6 +32,16 @@ module Stripe
         )
       end
 
+      # Retrieves the line items of a committed standalone transaction as a collection.
+      def list_line_items(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/tax/transactions/%<transaction>s/line_items", { transaction: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
       # Retrieves the line items of a committed standalone transaction as a collection.
       def self.list_line_items(transaction, params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/terminal/reader.rb

@@ -27,91 +27,71 @@ module Stripe
         )
       end
 
-      # Initiates a payment flow on a Reader.
-      def process_payment_intent(params = {}, opts = {})
-        request_stripe_object(
-          method: :post,
-          path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(self["id"]) }),
-          params: params,
-          opts: opts
-        )
-      end
-
-      # Initiates a setup intent flow on a Reader.
-      def process_setup_intent(params = {}, opts = {})
-        request_stripe_object(
-          method: :post,
-          path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(self["id"]) }),
-          params: params,
-          opts: opts
-        )
-      end
-
-      # Initiates a refund on a Reader
-      def refund_payment(params = {}, opts = {})
+      # Cancels the current reader action.
+      def self.cancel_action(reader, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(self["id"]) }),
+          path: format("/v1/terminal/readers/%<reader>s/cancel_action", { reader: CGI.escape(reader) }),
           params: params,
           opts: opts
         )
       end
 
-      # Sets reader display to show cart details.
-      def set_reader_display(params = {}, opts = {})
+      # Initiates an input collection flow on a Reader.
+      def collect_inputs(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(self["id"]) }),
+          path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      # Cancels the current reader action.
-      def self.cancel_action(reader, params = {}, opts = {})
+      # Initiates an input collection flow on a Reader.
+      def self.collect_inputs(reader, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/terminal/readers/%<reader>s/cancel_action", { reader: CGI.escape(reader) }),
+          path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(reader) }),
           params: params,
           opts: opts
         )
       end
 
-      # Initiates a payment flow on a Reader.
-      def self.process_payment_intent(reader, params = {}, opts = {})
+      # Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
+      def collect_payment_method(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(reader) }),
+          path: format("/v1/terminal/readers/%<reader>s/collect_payment_method", { reader: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      # Initiates a setup intent flow on a Reader.
-      def self.process_setup_intent(reader, params = {}, opts = {})
+      # Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
+      def self.collect_payment_method(reader, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(reader) }),
+          path: format("/v1/terminal/readers/%<reader>s/collect_payment_method", { reader: CGI.escape(reader) }),
           params: params,
           opts: opts
         )
       end
 
-      # Initiates a refund on a Reader
-      def self.refund_payment(reader, params = {}, opts = {})
+      # Finalizes a payment on a Reader.
+      def confirm_payment_intent(params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(reader) }),
+          path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      # Sets reader display to show cart details.
-      def self.set_reader_display(reader, params = {}, opts = {})
+      # Finalizes a payment on a Reader.
+      def self.confirm_payment_intent(reader, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(reader) }),
+          path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(reader) }),
           params: params,
           opts: opts
         )
@@ -157,6 +137,86 @@ module Stripe
         )
       end
 
+      # Initiates a payment flow on a Reader.
+      def process_payment_intent(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a payment flow on a Reader.
+      def self.process_payment_intent(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_payment_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a setup intent flow on a Reader.
+      def process_setup_intent(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a setup intent flow on a Reader.
+      def self.process_setup_intent(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/process_setup_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a refund on a Reader
+      def refund_payment(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Initiates a refund on a Reader
+      def self.refund_payment(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Sets reader display to show cart details.
+      def set_reader_display(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Sets reader display to show cart details.
+      def self.set_reader_display(reader, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/set_reader_display", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
       # Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
       def self.update(id, params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/treasury/financial_account.rb

@@ -15,71 +15,71 @@ module Stripe
         "treasury.financial_account"
       end
 
-      # Retrieves Features information associated with the FinancialAccount.
-      def retrieve_features(params = {}, opts = {})
+      # Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.
+      def self.create(params = {}, opts = {})
         request_stripe_object(
-          method: :get,
-          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(self["id"]) }),
+          method: :post,
+          path: "/v1/treasury/financial_accounts",
           params: params,
           opts: opts
         )
       end
 
-      # Updates the Features associated with a FinancialAccount.
-      def update_features(params = {}, opts = {})
+      # Returns a list of FinancialAccounts.
+      def self.list(filters = {}, opts = {})
         request_stripe_object(
-          method: :post,
-          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(self["id"]) }),
-          params: params,
+          method: :get,
+          path: "/v1/treasury/financial_accounts",
+          params: filters,
           opts: opts
         )
       end
 
       # Retrieves Features information associated with the FinancialAccount.
-      def self.retrieve_features(financial_account, params = {}, opts = {})
+      def retrieve_features(params = {}, opts = {})
         request_stripe_object(
           method: :get,
-          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(financial_account) }),
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(self["id"]) }),
           params: params,
           opts: opts
         )
       end
 
-      # Updates the Features associated with a FinancialAccount.
-      def self.update_features(financial_account, params = {}, opts = {})
+      # Retrieves Features information associated with the FinancialAccount.
+      def self.retrieve_features(financial_account, params = {}, opts = {})
         request_stripe_object(
-          method: :post,
+          method: :get,
           path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(financial_account) }),
           params: params,
           opts: opts
         )
       end
 
-      # Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.
-      def self.create(params = {}, opts = {})
+      # Updates the details of a FinancialAccount.
+      def self.update(id, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: "/v1/treasury/financial_accounts",
+          path: format("/v1/treasury/financial_accounts/%<id>s", { id: CGI.escape(id) }),
           params: params,
           opts: opts
         )
       end
 
-      # Returns a list of FinancialAccounts.
-      def self.list(filters = {}, opts = {})
+      # Updates the Features associated with a FinancialAccount.
+      def update_features(params = {}, opts = {})
         request_stripe_object(
-          method: :get,
-          path: "/v1/treasury/financial_accounts",
-          params: filters,
+          method: :post,
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(self["id"]) }),
+          params: params,
           opts: opts
         )
       end
 
-      # Updates the details of a FinancialAccount.
-      def self.update(id, params = {}, opts = {})
+      # Updates the Features associated with a FinancialAccount.
+      def self.update_features(financial_account, params = {}, opts = {})
         request_stripe_object(
           method: :post,
-          path: format("/v1/treasury/financial_accounts/%<id>s", { id: CGI.escape(id) }),
+          path: format("/v1/treasury/financial_accounts/%<financial_account>s/features", { financial_account: CGI.escape(financial_account) }),
           params: params,
           opts: opts
         )

data/lib/stripe/resources/treasury/transaction_entry.rb

@@ -12,10 +12,6 @@ module Stripe
         "treasury.transaction_entry"
       end
 
-      def self.resource_url
-        "/v1/treasury/transaction_entries"
-      end
-
       # Retrieves a list of TransactionEntry objects.
       def self.list(filters = {}, opts = {})
         request_stripe_object(
@@ -25,6 +21,10 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.resource_url
+        "/v1/treasury/transaction_entries"
+      end
     end
   end
 end

data/lib/stripe/resources.rb

@@ -3,6 +3,7 @@
 
 require "stripe/resources/account"
 require "stripe/resources/account_link"
+require "stripe/resources/account_notice"
 require "stripe/resources/account_session"
 require "stripe/resources/apple_pay_domain"
 require "stripe/resources/application_fee"
@@ -14,6 +15,9 @@ require "stripe/resources/bank_account"
 require "stripe/resources/billing_portal/configuration"
 require "stripe/resources/billing_portal/session"
 require "stripe/resources/capability"
+require "stripe/resources/capital/financing_offer"
+require "stripe/resources/capital/financing_summary"
+require "stripe/resources/capital/financing_transaction"
 require "stripe/resources/card"
 require "stripe/resources/cash_balance"
 require "stripe/resources/charge"
@@ -21,6 +25,7 @@ require "stripe/resources/checkout/session"
 require "stripe/resources/climate/order"
 require "stripe/resources/climate/product"
 require "stripe/resources/climate/supplier"
+require "stripe/resources/confirmation_token"
 require "stripe/resources/country_spec"
 require "stripe/resources/coupon"
 require "stripe/resources/credit_note"
@@ -28,34 +33,46 @@ require "stripe/resources/credit_note_line_item"
 require "stripe/resources/customer"
 require "stripe/resources/customer_balance_transaction"
 require "stripe/resources/customer_cash_balance_transaction"
+require "stripe/resources/customer_entitlement"
+require "stripe/resources/customer_entitlement_summary"
 require "stripe/resources/customer_session"
 require "stripe/resources/discount"
 require "stripe/resources/dispute"
+require "stripe/resources/entitlements/feature"
 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/financial_connections/account"
+require "stripe/resources/financial_connections/account_inferred_balance"
 require "stripe/resources/financial_connections/account_owner"
 require "stripe/resources/financial_connections/account_ownership"
 require "stripe/resources/financial_connections/session"
 require "stripe/resources/financial_connections/transaction"
 require "stripe/resources/funding_instructions"
+require "stripe/resources/gift_cards/card"
+require "stripe/resources/gift_cards/transaction"
 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/invoice_payment"
 require "stripe/resources/issuing/authorization"
 require "stripe/resources/issuing/card"
 require "stripe/resources/issuing/cardholder"
+require "stripe/resources/issuing/credit_underwriting_record"
 require "stripe/resources/issuing/dispute"
+require "stripe/resources/issuing/personalization_design"
+require "stripe/resources/issuing/physical_bundle"
 require "stripe/resources/issuing/token"
 require "stripe/resources/issuing/transaction"
 require "stripe/resources/line_item"
 require "stripe/resources/login_link"
 require "stripe/resources/mandate"
+require "stripe/resources/margin"
+require "stripe/resources/order"
 require "stripe/resources/payment_intent"
 require "stripe/resources/payment_link"
 require "stripe/resources/payment_method"
@@ -68,6 +85,9 @@ require "stripe/resources/price"
 require "stripe/resources/product"
 require "stripe/resources/promotion_code"
 require "stripe/resources/quote"
+require "stripe/resources/quote_phase"
+require "stripe/resources/quote_preview_invoice"
+require "stripe/resources/quote_preview_subscription_schedule"
 require "stripe/resources/radar/early_fraud_warning"
 require "stripe/resources/radar/value_list"
 require "stripe/resources/radar/value_list_item"
@@ -87,6 +107,7 @@ require "stripe/resources/subscription_item"
 require "stripe/resources/subscription_schedule"
 require "stripe/resources/tax/calculation"
 require "stripe/resources/tax/calculation_line_item"
+require "stripe/resources/tax/form"
 require "stripe/resources/tax/registration"
 require "stripe/resources/tax/settings"
 require "stripe/resources/tax/transaction"