stripe 13.0.1 → 13.1.0.pre.beta.3

data/lib/stripe/services/issuing/credit_underwriting_record_service.rb

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class CreditUnderwritingRecordService < StripeService
+      # Update a CreditUnderwritingRecord object to correct mistakes.
+      def correct(credit_underwriting_record, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a CreditUnderwritingRecord object with information about a credit application submission.
+      def create_from_application(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/issuing/credit_underwriting_records/create_from_application",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
+      def create_from_proactive_review(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/issuing/credit_underwriting_records/create_from_proactive_review",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a list of CreditUnderwritingRecord 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/issuing/credit_underwriting_records",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object from a decision made on a credit application.
+      def report_decision(credit_underwriting_record, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a CreditUnderwritingRecord object.
+      def retrieve(credit_underwriting_record, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class DisputeSettlementDetailService < StripeService
+      # Returns a list of Issuing DisputeSettlementDetail 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/issuing/dispute_settlement_details",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves an Issuing DisputeSettlementDetail object.
+      def retrieve(dispute_settlement_detail, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/issuing/dispute_settlement_details/%<dispute_settlement_detail>s", { dispute_settlement_detail: CGI.escape(dispute_settlement_detail) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/issuing_service.rb

@@ -3,14 +3,17 @@
 
 module Stripe
   class IssuingService < StripeService
-    attr_reader :authorizations, :cards, :cardholders, :disputes, :personalization_designs, :physical_bundles, :tokens, :transactions
+    attr_reader :authorizations, :cards, :cardholders, :credit_underwriting_records, :disputes, :dispute_settlement_details, :personalization_designs, :physical_bundles, :tokens, :transactions
 
     def initialize(requestor)
       super(requestor)
       @authorizations = Stripe::Issuing::AuthorizationService.new(@requestor)
       @cards = Stripe::Issuing::CardService.new(@requestor)
       @cardholders = Stripe::Issuing::CardholderService.new(@requestor)
+      @credit_underwriting_records = Stripe::Issuing::CreditUnderwritingRecordService
+                                     .new(@requestor)
       @disputes = Stripe::Issuing::DisputeService.new(@requestor)
+      @dispute_settlement_details = Stripe::Issuing::DisputeSettlementDetailService.new(@requestor)
       @personalization_designs = Stripe::Issuing::PersonalizationDesignService.new(@requestor)
       @physical_bundles = Stripe::Issuing::PhysicalBundleService.new(@requestor)
       @tokens = Stripe::Issuing::TokenService.new(@requestor)

data/lib/stripe/services/margin_service.rb

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class MarginService < StripeService
+    # Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/billing/margins",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieve a list of your margins.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/billing/margins",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieve a margin object with the given ID.
+    def retrieve(margin, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/billing/margins/%<margin>s", { margin: CGI.escape(margin) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Update the specified margin object. Certain fields of the margin object are not editable.
+    def update(margin, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/billing/margins/%<margin>s", { margin: CGI.escape(margin) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/order_line_item_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class OrderLineItemService < StripeService
+    # When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
+    def list(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/order_service.rb

@@ -0,0 +1,78 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class OrderService < StripeService
+    attr_reader :line_items
+
+    def initialize(requestor)
+      super(requestor)
+      @line_items = Stripe::OrderLineItemService.new(@requestor)
+    end
+
+    # Cancels the order as well as the payment intent if one is attached.
+    def cancel(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Creates a new open order object.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/orders", params: params, opts: opts, base_address: :api)
+    end
+
+    # Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/orders", params: params, opts: opts, base_address: :api)
+    end
+
+    # Reopens a submitted order.
+    def reopen(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the details of an existing order. Supply the unique order ID from either an order creation request or the order list, and Stripe will return the corresponding order information.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/orders/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called.
+    def submit(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    def update(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/orders/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/payment_intent_service.rb

@@ -99,6 +99,32 @@ module Stripe
       )
     end
 
+    # Perform a decremental authorization on an eligible
+    # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the
+    # PaymentIntent's status must be requires_capture and
+    # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization)
+    # must be available.
+    #
+    # Decremental authorizations decrease the authorized amount on your customer's card
+    # to the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
+    #
+    # After decrement, the PaymentIntent object
+    # returns with the updated
+    # [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
+    # The PaymentIntent will now be capturable up to the new authorized amount.
+    #
+    # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.
+    # After it's fully captured, a PaymentIntent can no longer be decremented.
+    def decrement_authorization(intent, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/decrement_authorization", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Perform an incremental authorization on an eligible
     # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the
     # PaymentIntent's status must be requires_capture and

data/lib/stripe/services/quote_line_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class QuoteLineService < StripeService
+    # Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
+    def list(quote, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/lines", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/quote_preview_invoice_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class QuotePreviewInvoiceService < StripeService
+    # Preview the invoices that would be generated by accepting the quote.
+    def list(quote, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/preview_invoices", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/quote_preview_subscription_schedule_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class QuotePreviewSubscriptionScheduleService < StripeService
+    # Preview the schedules that would be generated by accepting the quote
+    def list(quote, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/preview_subscription_schedules", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/quote_service.rb

@@ -3,10 +3,14 @@
 
 module Stripe
   class QuoteService < StripeService
-    attr_reader :line_items, :computed_upfront_line_items
+    attr_reader :preview_invoices, :preview_subscription_schedules, :lines, :line_items, :computed_upfront_line_items
 
     def initialize(requestor)
       super(requestor)
+      @preview_invoices = Stripe::QuotePreviewInvoiceService.new(@requestor)
+      @preview_subscription_schedules = Stripe::QuotePreviewSubscriptionScheduleService
+                                        .new(@requestor)
+      @lines = Stripe::QuoteLineService.new(@requestor)
       @line_items = Stripe::QuoteLineItemService.new(@requestor)
       @computed_upfront_line_items = Stripe::QuoteComputedUpfrontLineItemsService.new(@requestor)
     end
@@ -54,6 +58,39 @@ module Stripe
       request(method: :get, path: "/v1/quotes", params: params, opts: opts, base_address: :api)
     end
 
+    # Preview the invoice line items that would be generated by accepting the quote.
+    def list_preview_invoice_lines(quote, preview_invoice, params = {}, opts = {})
+      request(
+        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,
+        base_address: :api
+      )
+    end
+
+    # Converts a stale quote to draft.
+    def mark_draft(quote, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_draft", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Converts a draft or open quote to stale.
+    def mark_stale(quote, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_stale", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
     def pdf(quote, params = {}, opts = {}, &read_body_chunk_block)
       opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
@@ -67,6 +104,17 @@ module Stripe
       )
     end
 
+    # Recompute the upcoming invoice estimate for the quote.
+    def reestimate(quote, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/reestimate", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Retrieves the quote with the given ID.
     def retrieve(quote, params = {}, opts = {})
       request(

data/lib/stripe/services/subscription_schedule_service.rb

@@ -3,6 +3,17 @@
 
 module Stripe
   class SubscriptionScheduleService < StripeService
+    # Amends an existing subscription schedule.
+    def amend(schedule, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    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(schedule, params = {}, opts = {})
       request(

data/lib/stripe/services/tax/association_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class AssociationService < StripeService
+      # Finds a tax association object by PaymentIntent id.
+      def find(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/tax/associations/find",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/tax/form_service.rb

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class FormService < StripeService
+      # 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 list(params = {}, opts = {})
+        request(method: :get, path: "/v1/tax/forms", params: params, opts: opts, base_address: :api)
+      end
+
+      # Download the PDF for a tax form.
+      def pdf(id, params = {}, opts = {}, &read_body_chunk_block)
+        opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
+        request_stream(
+          method: :get,
+          path: format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :files,
+          &read_body_chunk_block
+        )
+      end
+
+      # Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/tax/forms/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/tax_service.rb

@@ -3,11 +3,13 @@
 
 module Stripe
   class TaxService < StripeService
-    attr_reader :calculations, :registrations, :settings, :transactions
+    attr_reader :associations, :calculations, :forms, :registrations, :settings, :transactions
 
     def initialize(requestor)
       super(requestor)
+      @associations = Stripe::Tax::AssociationService.new(@requestor)
       @calculations = Stripe::Tax::CalculationService.new(@requestor)
+      @forms = Stripe::Tax::FormService.new(@requestor)
       @registrations = Stripe::Tax::RegistrationService.new(@requestor)
       @settings = Stripe::Tax::SettingsService.new(@requestor)
       @transactions = Stripe::Tax::TransactionService.new(@requestor)

data/lib/stripe/services/terminal/reader_collected_data_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderCollectedDataService < StripeService
+      # Retrieve data collected using Reader hardware.
+      def retrieve(reader_collected_data, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/terminal/reader_collected_data/%<reader_collected_data>s", { reader_collected_data: CGI.escape(reader_collected_data) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/terminal/reader_service.rb

@@ -15,6 +15,39 @@ module Stripe
         )
       end
 
+      # Initiates an input collection flow on a Reader.
+      def collect_inputs(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
+      def collect_payment_method(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/collect_payment_method", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Finalizes a payment on a Reader.
+      def confirm_payment_intent(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
       # Creates a new Reader object.
       def create(params = {}, opts = {})
         request(

data/lib/stripe/services/terminal_service.rb

@@ -3,7 +3,7 @@
 
 module Stripe
   class TerminalService < StripeService
-    attr_reader :configurations, :connection_tokens, :locations, :readers
+    attr_reader :configurations, :connection_tokens, :locations, :readers, :reader_collected_data
 
     def initialize(requestor)
       super(requestor)
@@ -11,6 +11,7 @@ module Stripe
       @connection_tokens = Stripe::Terminal::ConnectionTokenService.new(@requestor)
       @locations = Stripe::Terminal::LocationService.new(@requestor)
       @readers = Stripe::Terminal::ReaderService.new(@requestor)
+      @reader_collected_data = Stripe::Terminal::ReaderCollectedDataService.new(@requestor)
     end
   end
 end

data/lib/stripe/services/test_helpers/issuing/card_service.rb

@@ -48,6 +48,17 @@ module Stripe
             base_address: :api
           )
         end
+
+        # Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia' or later.
+        def submit_card(card, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/submit", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
       end
     end
   end

data/lib/stripe/services/token_service.rb

@@ -4,7 +4,7 @@
 module Stripe
   class TokenService < StripeService
     # Creates a single-use token that represents a bank account's details.
-    # You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
+    # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
     def create(params = {}, opts = {})
       request(method: :post, path: "/v1/tokens", params: params, opts: opts, base_address: :api)
     end