stripe 9.3.0 → 9.4.0.pre.beta.1

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

@@ -6,9 +6,12 @@ module Stripe
     # A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
     class Account < APIResource
       extend Stripe::APIOperations::List
+      extend Stripe::APIOperations::NestedResource
 
       OBJECT_NAME = "financial_connections.account"
 
+      nested_resource_class_methods :inferred_balance, operations: %i[list]
+
       def disconnect(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -36,6 +39,24 @@ module Stripe
         )
       end
 
+      def subscribe(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def unsubscribe(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
       def self.disconnect(account, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -62,6 +83,24 @@ module Stripe
           opts: opts
         )
       end
+
+      def self.subscribe(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.unsubscribe(account, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

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

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
+    class InferredBalance < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "financial_connections.account_inferred_balance"
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # A Transaction represents a real transaction that affects a Financial Connections Account balance.
+    class Transaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "financial_connections.transaction"
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    # A gift card represents a single gift card owned by a customer, including the
+    # remaining balance, gift card code, and whether or not it is active.
+    class Card < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "gift_cards.card"
+
+      def self.validate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/gift_cards/cards/validate",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    # A gift card transaction represents a single transaction on a referenced gift card.
+    # A transaction is in one of three states, `confirmed`, `held` or `canceled`. A `confirmed`
+    # transaction is one that has added/deducted funds. A `held` transaction has created a
+    # temporary hold on funds, which can then be cancelled or confirmed. A `held` transaction
+    # can be confirmed into a `confirmed` transaction, or canceled into a `canceled` transaction.
+    # A `canceled` transaction has no effect on a gift card's balance.
+    class Transaction < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "gift_cards.transaction"
+
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def confirm(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.cancel(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.confirm(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # A Card Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.
+    class CardBundle < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.card_bundle"
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # A Card Design is a logical grouping of a Card Bundle, card logo, and carrier text that represents a product line.
+    class CardDesign < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "issuing.card_design"
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = CardDesign
+
+        def self.activate_testmode(card_design, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/card_designs/%<card_design>s/status/activate", { card_design: CGI.escape(card_design) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.deactivate_testmode(card_design, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/card_designs/%<card_design>s/status/deactivate", { card_design: CGI.escape(card_design) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def self.reject_testmode(card_design, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/card_designs/%<card_design>s/status/reject", { card_design: CGI.escape(card_design) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def activate_testmode(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/card_designs/%<card_design>s/status/activate", { card_design: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def deactivate_testmode(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/card_designs/%<card_design>s/status/deactivate", { card_design: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        def reject_testmode(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/card_designs/%<card_design>s/status/reject", { card_design: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/order.rb

@@ -0,0 +1,89 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # An Order describes a purchase being made by a customer, including the
+  # products & quantities being purchased, the order status, the payment information,
+  # and the billing/shipping details.
+  #
+  # Related guide: [Orders overview](https://stripe.com/docs/orders)
+  class Order < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "order"
+
+    def cancel(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def list_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def reopen(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def submit(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.cancel(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_line_items(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.reopen(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.submit(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/quote.rb

@@ -8,9 +8,13 @@ module Stripe
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
 
     OBJECT_NAME = "quote"
 
+    nested_resource_class_methods :preview_invoice, operations: %i[list]
+    nested_resource_class_methods :preview_subscription_schedule, operations: %i[list]
+
     def accept(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -29,6 +33,15 @@ module Stripe
       )
     end
 
+    def draft_quote(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_draft", { quote: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def finalize_quote(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -56,6 +69,24 @@ module Stripe
       )
     end
 
+    def list_lines(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/lines", { quote: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def mark_stale_quote(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_stale", { quote: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def pdf(params = {}, opts = {}, &read_body_chunk_block)
       config = opts[:client]&.config || Stripe.config
       opts = { api_base: config.uploads_base }.merge(opts)
@@ -68,6 +99,24 @@ module Stripe
       )
     end
 
+    def preview_invoice_lines(preview_invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/preview_invoices/%<preview_invoice>s/lines", { quote: CGI.escape(self["id"]), preview_invoice: CGI.escape(preview_invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def reestimate(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/reestimate", { quote: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def self.accept(quote, params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -86,6 +135,15 @@ module Stripe
       )
     end
 
+    def self.draft_quote(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_draft", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def self.finalize_quote(quote, params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -113,6 +171,24 @@ module Stripe
       )
     end
 
+    def self.list_lines(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/lines", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.mark_stale_quote(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_stale", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def self.pdf(quote, params = {}, opts = {}, &read_body_chunk_block)
       config = opts[:client]&.config || Stripe.config
       opts = { api_base: config.uploads_base }.merge(opts)
@@ -124,5 +200,23 @@ module Stripe
         &read_body_chunk_block
       )
     end
+
+    def self.preview_invoice_lines(quote, preview_invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/preview_invoices/%<preview_invoice>s/lines", { quote: CGI.escape(quote), preview_invoice: CGI.escape(preview_invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.reestimate(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/reestimate", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/quote_phase.rb

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A quote phase describes the line items, coupons, and trialing status of a subscription for a predefined time period.
+  class QuotePhase < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "quote_phase"
+
+    def list_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_line_items(quote_phase, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(quote_phase) }),
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/quote_preview_invoice.rb

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Invoices are statements of amounts owed by a customer, and are either
+  # generated one-off, or generated periodically from a subscription.
+  #
+  # They contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments
+  # that may be caused by subscription upgrades/downgrades (if necessary).
+  #
+  # If your invoice is configured to be billed through automatic charges,
+  # Stripe automatically finalizes your invoice and attempts payment. Note
+  # that finalizing the invoice,
+  # [when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does
+  # not happen immediately as the invoice is created. Stripe waits
+  # until one hour after the last webhook was successfully sent (or the last
+  # webhook timed out after failing). If you (and the platforms you may have
+  # connected to) have no webhooks configured, Stripe waits one hour after
+  # creation to finalize the invoice.
+  #
+  # If your invoice is configured to be billed by sending an email, then based on your
+  # [email settings](https://dashboard.stripe.com/account/billing/automatic),
+  # Stripe will email the invoice to your customer and await payment. These
+  # emails can contain a link to a hosted page to pay the invoice.
+  #
+  # Stripe applies any customer credit on the account before determining the
+  # amount due for the invoice (i.e., the amount that will be actually
+  # charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge
+  # per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
+  # invoice is automatically marked paid, and we add the amount due to the
+  # customer's credit balance which is applied to the next invoice.
+  #
+  # More details on the customer's credit balance are
+  # [here](https://stripe.com/docs/billing/customer/balance).
+  #
+  # Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)
+  class QuotePreviewInvoice < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "quote_preview_invoice"
+  end
+end

data/lib/stripe/resources/quote_preview_schedule.rb

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

data/lib/stripe/resources/subscription_schedule.rb

@@ -12,6 +12,15 @@ module Stripe
 
     OBJECT_NAME = "subscription_schedule"
 
+    def amend(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -30,6 +39,15 @@ module Stripe
       )
     end
 
+    def self.amend(schedule, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def self.cancel(schedule, params = {}, opts = {})
       request_stripe_object(
         method: :post,

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

@@ -0,0 +1,39 @@
+# 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 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
+
+      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/registration.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    # A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).
+    #
+    # Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).
+    #
+    # Related guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)
+    class Registration < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "tax.registration"
+    end
+  end
+end