stripe 13.1.0 → 13.2.0.pre.beta.1

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

@@ -37,6 +37,66 @@ module Stripe
         )
       end
 
+      # 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/collect_inputs", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # 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/collect_inputs", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # 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/collect_payment_method", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # 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/collect_payment_method", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Finalizes a payment on a Reader.
+      def confirm_payment_intent(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # 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/confirm_payment_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts
+        )
+      end
+
       # Creates a new Reader object.
       def self.create(params = {}, opts = {})
         request_stripe_object(

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

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    # Returns data collected by Terminal readers. This data is only stored for 24 hours.
+    class ReaderCollectedData < APIResource
+      OBJECT_NAME = "terminal.reader_collected_data"
+      def self.object_name
+        "terminal.reader_collected_data"
+      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"
@@ -22,6 +23,9 @@ require "stripe/resources/billing/meter_event_summary"
 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"
@@ -48,22 +52,29 @@ 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/institution"
 require "stripe/resources/financial_connections/session"
 require "stripe/resources/financial_connections/transaction"
 require "stripe/resources/forwarding/request"
 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/invoice_rendering_template"
 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/dispute_settlement_detail"
 require "stripe/resources/issuing/personalization_design"
 require "stripe/resources/issuing/physical_bundle"
 require "stripe/resources/issuing/token"
@@ -71,6 +82,8 @@ 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"
@@ -84,6 +97,8 @@ require "stripe/resources/product"
 require "stripe/resources/product_feature"
 require "stripe/resources/promotion_code"
 require "stripe/resources/quote"
+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"
@@ -101,8 +116,10 @@ require "stripe/resources/source_transaction"
 require "stripe/resources/subscription"
 require "stripe/resources/subscription_item"
 require "stripe/resources/subscription_schedule"
+require "stripe/resources/tax/association"
 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"
@@ -114,6 +131,7 @@ require "stripe/resources/terminal/configuration"
 require "stripe/resources/terminal/connection_token"
 require "stripe/resources/terminal/location"
 require "stripe/resources/terminal/reader"
+require "stripe/resources/terminal/reader_collected_data"
 require "stripe/resources/test_helpers/test_clock"
 require "stripe/resources/token"
 require "stripe/resources/topup"

data/lib/stripe/services/account_notice_service.rb

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountNoticeService < StripeService
+    # Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/account_notices",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves an AccountNotice object.
+    def retrieve(account_notice, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/account_notices/%<account_notice>s", { account_notice: CGI.escape(account_notice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an AccountNotice object.
+    def update(account_notice, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/account_notices/%<account_notice>s", { account_notice: CGI.escape(account_notice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/capital/financing_offer_service.rb

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    class FinancingOfferService < StripeService
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/capital/financing_offers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def mark_delivered(financing_offer, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Get the details of the financing offer
+      def retrieve(financing_offer, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/capital/financing_summary_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    class FinancingSummaryService < StripeService
+      # Retrieve the financing state for the account that was authenticated in the request.
+      def retrieve(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/capital/financing_summary",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/capital/financing_transaction_service.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    class FinancingTransactionService < StripeService
+      # Returns a list of financing transactions. The transactions are returned in sorted order,
+      # with the most recent transactions appearing first.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/capital/financing_transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a financing transaction for a financing offer.
+      def retrieve(financing_transaction, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/capital/financing_transactions/%<financing_transaction>s", { financing_transaction: CGI.escape(financing_transaction) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/capital_service.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CapitalService < StripeService
+    attr_reader :financing_offers, :financing_summary, :financing_transactions
+
+    def initialize(requestor)
+      super(requestor)
+      @financing_offers = Stripe::Capital::FinancingOfferService.new(@requestor)
+      @financing_summary = Stripe::Capital::FinancingSummaryService.new(@requestor)
+      @financing_transactions = Stripe::Capital::FinancingTransactionService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountInferredBalanceService < StripeService
+      # Lists the recorded inferred balances for a Financial Connections Account.
+      def list(account, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/inferred_balances", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/financial_connections/account_service.rb

@@ -4,10 +4,12 @@
 module Stripe
   module FinancialConnections
     class AccountService < StripeService
-      attr_reader :owners
+      attr_reader :inferred_balances, :owners
 
       def initialize(requestor)
         super(requestor)
+        @inferred_balances = Stripe::FinancialConnections::AccountInferredBalanceService
+                             .new(@requestor)
         @owners = Stripe::FinancialConnections::AccountOwnerService.new(@requestor)
       end
 

data/lib/stripe/services/financial_connections/institution_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class InstitutionService < StripeService
+      # Returns a list of Financial Connections Institution objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/financial_connections/institutions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Financial Connections Institution.
+      def retrieve(institution, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/institutions/%<institution>s", { institution: CGI.escape(institution) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/financial_connections_service.rb

@@ -3,11 +3,12 @@
 
 module Stripe
   class FinancialConnectionsService < StripeService
-    attr_reader :accounts, :sessions, :transactions
+    attr_reader :accounts, :institutions, :sessions, :transactions
 
     def initialize(requestor)
       super(requestor)
       @accounts = Stripe::FinancialConnections::AccountService.new(@requestor)
+      @institutions = Stripe::FinancialConnections::InstitutionService.new(@requestor)
       @sessions = Stripe::FinancialConnections::SessionService.new(@requestor)
       @transactions = Stripe::FinancialConnections::TransactionService.new(@requestor)
     end

data/lib/stripe/services/gift_cards/card_service.rb

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    class CardService < StripeService
+      # Creates a new gift card object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/gift_cards/cards",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # List gift cards for an account
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/gift_cards/cards",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve a gift card by id
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Update a gift card
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Validates a gift card code, returning the matching gift card object if it exists.
+      def validate(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/gift_cards/cards/validate",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/gift_cards/transaction_service.rb

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    class TransactionService < StripeService
+      # Cancel a gift card transaction
+      def cancel(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Confirm a gift card transaction
+      def confirm(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Create a gift card transaction
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/gift_cards/transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # List gift card transactions for a gift card
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/gift_cards/transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the gift card transaction.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Update a gift card transaction
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/gift_cards_service.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardsService < StripeService
+    attr_reader :cards, :transactions
+
+    def initialize(requestor)
+      super(requestor)
+      @cards = Stripe::GiftCards::CardService.new(@requestor)
+      @transactions = Stripe::GiftCards::TransactionService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/invoice_payment_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class InvoicePaymentService < StripeService
+    # When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
+    def list(invoice, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/invoices/%<invoice>s/payments", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the invoice payment with the given ID.
+    def retrieve(invoice, invoice_payment, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/invoices/%<invoice>s/payments/%<invoice_payment>s", { invoice: CGI.escape(invoice), invoice_payment: CGI.escape(invoice_payment) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/invoice_service.rb

@@ -3,10 +3,11 @@
 
 module Stripe
   class InvoiceService < StripeService
-    attr_reader :line_items, :upcoming_lines
+    attr_reader :payments, :line_items, :upcoming_lines
 
     def initialize(requestor)
       super(requestor)
+      @payments = Stripe::InvoicePaymentService.new(@requestor)
       @line_items = Stripe::InvoiceLineItemService.new(@requestor)
       @upcoming_lines = Stripe::InvoiceUpcomingLinesService.new(@requestor)
     end
@@ -22,6 +23,48 @@ module Stripe
       )
     end
 
+    # Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
+    #
+    # For Out of Band Payment, the payment is credited to the invoice immediately, increasing the amount_paid
+    # of the invoice and subsequently transitioning the status of the invoice to paid if necessary.
+    #
+    # For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
+    # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
+    # invoice's status becomes paid.
+    #
+    # If the PaymentIntent's status is already succeeded when it's attached, it's
+    # credited to the invoice immediately.
+    #
+    # See: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create) to learn more.
+    def attach_payment(invoice, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/attach_payment", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Attaches a PaymentIntent to the invoice, adding it to the list of payments.
+    # When the PaymentIntent's status changes to succeeded, the payment is credited
+    # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
+    # invoice's status becomes paid.
+    #
+    # If the PaymentIntent's status is already succeeded when it is attached, it is
+    # credited to the invoice immediately.
+    #
+    # Related guide: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create)
+    def attach_payment_intent(invoice, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/attach_payment_intent", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers.
     def create(params = {}, opts = {})
       request(method: :post, path: "/v1/invoices", params: params, opts: opts, base_address: :api)