stripe 18.1.0 → 18.2.0.pre.alpha.2

data/lib/stripe/services/payment_intent_service.rb

@@ -111,6 +111,32 @@ module Stripe
       )
     end
 
+    # Perform a decremental authorization on an eligible
+    # [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
+    # PaymentIntent's status must be requires_capture and
+    # [decremental_authorization.status](https://docs.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://docs.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://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the
     # PaymentIntent's status must be requires_capture and
@@ -185,6 +211,17 @@ module Stripe
       )
     end
 
+    # Trigger an external action on a PaymentIntent.
+    def trigger_action(intent, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/test/payment_intents/%<intent>s/trigger_action", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Updates properties on a PaymentIntent object without confirming.
     #
     # Depending on which properties you update, you might need to confirm the

data/lib/stripe/services/payment_method_service.rb

@@ -26,6 +26,17 @@ module Stripe
       )
     end
 
+    # Retrieves a PaymentMethod's Balance.
+    def check_balance(payment_method, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/payment_methods/%<payment_method>s/check_balance", { payment_method: CGI.escape(payment_method) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Creates a PaymentMethod object. Read the [Stripe.js reference](https://docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js.
     #
     # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the <a href="/docs/payments/save-and-reuse">SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment.

data/lib/stripe/services/privacy/redaction_job_service.rb

@@ -0,0 +1,104 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    class RedactionJobService < StripeService
+      attr_reader :validation_errors
+
+      def initialize(requestor)
+        super
+        @validation_errors = Stripe::Privacy::RedactionJobValidationErrorService.new(@requestor)
+      end
+
+      # You can cancel a redaction job when it's in one of these statuses: ready, failed.
+      #
+      # Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.
+      def cancel(job, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s/cancel", { job: CGI.escape(job) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a redaction job. When a job is created, it will start to validate.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/privacy/redaction_jobs",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of redaction jobs.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/privacy/redaction_jobs",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a previously created redaction job.
+      def retrieve(job, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/privacy/redaction_jobs/%<job>s", { job: CGI.escape(job) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Run a redaction job in a ready status.
+      #
+      # When you run a job, the configured objects will be redacted asynchronously. This action is irreversible and cannot be canceled once started.
+      #
+      # The status of the job will move to redacting. Once all of the objects are redacted, the status will become succeeded. If the job's validation_behavior is set to fix, the automatic fixes will be applied to objects at this step.
+      def run(job, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s/run", { job: CGI.escape(job) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates the properties of a redaction job without running or canceling the job.
+      #
+      # If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.
+      def update(job, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s", { job: CGI.escape(job) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Validate a redaction job when it is in a failed status.
+      #
+      # When a job is created, it automatically begins to validate on the configured objects' eligibility for redaction. Use this to validate the job again after its validation errors are resolved or the job's validation_behavior is changed.
+      #
+      # The status of the job will move to validating. Once all of the objects are validated, the status of the job will become ready. If there are any validation errors preventing the job from running, the status will become failed.
+      def validate(job, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/privacy/redaction_jobs/%<job>s/validate", { job: CGI.escape(job) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/privacy/redaction_job_validation_error_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    class RedactionJobValidationErrorService < StripeService
+      # Returns a list of validation errors for the specified redaction job.
+      def list(job, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/privacy/redaction_jobs/%<job>s/validation_errors", { job: CGI.escape(job) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/privacy_service.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PrivacyService < StripeService
+    attr_reader :redaction_jobs
+
+    def initialize(requestor)
+      super
+      @redaction_jobs = Stripe::Privacy::RedactionJobService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/product_catalog/trial_offer_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module ProductCatalog
+    class TrialOfferService < StripeService
+      # Creates a trial offer.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/product_catalog/trial_offers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/product_catalog_service.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ProductCatalogService < StripeService
+    attr_reader :trial_offers
+
+    def initialize(requestor)
+      super
+      @trial_offers = Stripe::ProductCatalog::TrialOfferService.new(@requestor)
+    end
+  end
+end

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,12 +3,16 @@
 
 module Stripe
   class QuoteService < StripeService
-    attr_reader :computed_upfront_line_items, :line_items
+    attr_reader :computed_upfront_line_items, :lines, :line_items, :preview_invoices, :preview_subscription_schedules
 
     def initialize(requestor)
       super
       @computed_upfront_line_items = Stripe::QuoteComputedUpfrontLineItemsService.new(@requestor)
+      @lines = Stripe::QuoteLineService.new(@requestor)
       @line_items = Stripe::QuoteLineItemService.new(@requestor)
+      @preview_invoices = Stripe::QuotePreviewInvoiceService.new(@requestor)
+      @preview_subscription_schedules = Stripe::QuotePreviewSubscriptionScheduleService
+                                        .new(@requestor)
     end
 
     # Accepts the specified quote.
@@ -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/radar/account_evaluation_service.rb

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Radar
+    class AccountEvaluationService < StripeService
+      # Creates a new AccountEvaluation object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/radar/account_evaluations",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves an AccountEvaluation object.
+      def retrieve(account_evaluation, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/radar/account_evaluations/%<account_evaluation>s", { account_evaluation: CGI.escape(account_evaluation) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Reports an event on an AccountEvaluation object.
+      def update(account_evaluation, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/radar/account_evaluations/%<account_evaluation>s/report_event", { account_evaluation: CGI.escape(account_evaluation) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/radar_service.rb

@@ -3,10 +3,11 @@
 
 module Stripe
   class RadarService < StripeService
-    attr_reader :early_fraud_warnings, :value_lists, :value_list_items
+    attr_reader :account_evaluations, :early_fraud_warnings, :value_lists, :value_list_items
 
     def initialize(requestor)
       super
+      @account_evaluations = Stripe::Radar::AccountEvaluationService.new(@requestor)
       @early_fraud_warnings = Stripe::Radar::EarlyFraudWarningService.new(@requestor)
       @value_lists = Stripe::Radar::ValueListService.new(@requestor)
       @value_list_items = Stripe::Radar::ValueListItemService.new(@requestor)

data/lib/stripe/services/shared_payment/granted_token_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module SharedPayment
+    class GrantedTokenService < StripeService
+      # Retrieves an existing SharedPaymentGrantedToken object
+      def retrieve(shared_payment_granted_token, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/shared_payment/granted_tokens/%<shared_payment_granted_token>s", { shared_payment_granted_token: CGI.escape(shared_payment_granted_token) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/shared_payment_service.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SharedPaymentService < StripeService
+    attr_reader :granted_tokens
+
+    def initialize(requestor)
+      super
+      @granted_tokens = Stripe::SharedPayment::GrantedTokenService.new(@requestor)
+    end
+  end
+end

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/subscription_service.rb

@@ -3,6 +3,17 @@
 
 module Stripe
   class SubscriptionService < StripeService
+    # Attach a Billing Cadence to an existing subscription. When attached, the subscription is billed by the Billing Cadence, potentially sharing invoices with the other subscriptions linked to the Billing Cadence.
+    def attach_cadence(subscription, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/attach_cadence", { subscription: CGI.escape(subscription) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
     #
     # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
@@ -68,6 +79,17 @@ module Stripe
       )
     end
 
+    # Pauses a subscription by transitioning it to the paused status. A paused subscription does not generate invoices and will not advance to new billing periods. The subscription can be resumed later using the resume endpoint. Cannot pause subscriptions with attached schedules.
+    def pause(subscription, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/pause", { subscription: CGI.escape(subscription) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
     def resume(subscription, params = {}, opts = {})
       request(

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/location_service.rb

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class LocationService < StripeService
+      # Create a tax location to use in calculating taxes for a service, ticket, or other type of product. The resulting object contains the id, address, name, description, and current operational status of the tax location.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/tax/locations",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve a list of all tax locations. Tax locations can represent the venues for services, tickets, or other product types.
+      #
+      # The response includes detailed information for each tax location, such as its address, name, description, and current operational status.
+      #
+      # You can paginate through the list by using the limit parameter to control the number of results returned in each request.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/tax/locations",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Fetch the details of a specific tax location using its unique identifier. Use a tax location to calculate taxes based on the location of the end product, such as a performance, instead of the customer address. For more details, check the [integration guide](https://docs.stripe.com/tax/tax-for-tickets/integration-guide).
+      def retrieve(location, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/tax/locations/%<location>s", { location: CGI.escape(location) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/tax_service.rb

@@ -3,12 +3,14 @@
 
 module Stripe
   class TaxService < StripeService
-    attr_reader :associations, :calculations, :registrations, :settings, :transactions
+    attr_reader :associations, :calculations, :forms, :locations, :registrations, :settings, :transactions
 
     def initialize(requestor)
       super
       @associations = Stripe::Tax::AssociationService.new(@requestor)
       @calculations = Stripe::Tax::CalculationService.new(@requestor)
+      @forms = Stripe::Tax::FormService.new(@requestor)
+      @locations = Stripe::Tax::LocationService.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_service.rb

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