stripe 18.0.0 → 18.1.0.pre.beta.1

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

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,12 +3,13 @@
 
 module Stripe
   class TaxService < StripeService
-    attr_reader :associations, :calculations, :registrations, :settings, :transactions
+    attr_reader :associations, :calculations, :forms, :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)
       @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

data/lib/stripe/services/v1_services.rb

@@ -4,7 +4,7 @@ module Stripe
   class V1Services < StripeService
     # v1 accessors: The beginning of the section generated from our OpenAPI spec
     attr_reader :accounts
-    attr_reader :account_links, :account_sessions, :apple_pay_domains, :application_fees, :apps, :balance, :balance_settings, :balance_transactions, :billing, :billing_portal, :charges, :checkout, :climate, :confirmation_tokens, :country_specs, :coupons, :credit_notes, :customers, :customer_sessions, :disputes, :entitlements, :ephemeral_keys, :events, :exchange_rates, :files, :file_links, :financial_connections, :forwarding, :identity, :invoices, :invoice_items, :invoice_payments, :invoice_rendering_templates, :issuing, :mandates, :payment_attempt_records, :payment_intents, :payment_links, :payment_methods, :payment_method_configurations, :payment_method_domains, :payment_records, :payouts, :plans, :prices, :products, :promotion_codes, :quotes, :radar, :refunds, :reporting, :reviews, :setup_attempts, :setup_intents, :shipping_rates, :sigma, :sources, :subscriptions, :subscription_items, :subscription_schedules, :tax, :tax_codes, :tax_ids, :tax_rates, :terminal, :test_helpers, :tokens, :topups, :transfers, :treasury, :webhook_endpoints
+    attr_reader :account_links, :account_notices, :account_sessions, :apple_pay_domains, :application_fees, :apps, :balance, :balance_settings, :balance_transactions, :billing, :billing_portal, :capital, :charges, :checkout, :climate, :confirmation_tokens, :country_specs, :coupons, :credit_notes, :customers, :customer_sessions, :disputes, :entitlements, :ephemeral_keys, :events, :exchange_rates, :external_accounts, :files, :file_links, :financial_connections, :forwarding, :fx_quotes, :identity, :invoices, :invoice_items, :invoice_payments, :invoice_rendering_templates, :issuing, :mandates, :margins, :orders, :payment_attempt_records, :payment_intents, :payment_links, :payment_methods, :payment_method_configurations, :payment_method_domains, :payment_records, :payouts, :plans, :prices, :privacy, :products, :promotion_codes, :quotes, :radar, :refunds, :reporting, :reviews, :setup_attempts, :setup_intents, :shipping_rates, :sigma, :sources, :subscriptions, :subscription_items, :subscription_schedules, :tax, :tax_codes, :tax_ids, :tax_rates, :terminal, :test_helpers, :tokens, :topups, :transfers, :treasury, :webhook_endpoints
     # v1 accessors: The end of the section generated from our OpenAPI spec
 
     # OAuthService is manually maintained, as it has special behaviors
@@ -15,6 +15,7 @@ module Stripe
       # v1 services: The beginning of the section generated from our OpenAPI spec
       @accounts = Stripe::AccountService.new(@requestor)
       @account_links = Stripe::AccountLinkService.new(@requestor)
+      @account_notices = Stripe::AccountNoticeService.new(@requestor)
       @account_sessions = Stripe::AccountSessionService.new(@requestor)
       @apple_pay_domains = Stripe::ApplePayDomainService.new(@requestor)
       @application_fees = Stripe::ApplicationFeeService.new(@requestor)
@@ -24,6 +25,7 @@ module Stripe
       @balance_transactions = Stripe::BalanceTransactionService.new(@requestor)
       @billing = Stripe::BillingService.new(@requestor)
       @billing_portal = Stripe::BillingPortalService.new(@requestor)
+      @capital = Stripe::CapitalService.new(@requestor)
       @charges = Stripe::ChargeService.new(@requestor)
       @checkout = Stripe::CheckoutService.new(@requestor)
       @climate = Stripe::ClimateService.new(@requestor)
@@ -38,10 +40,12 @@ module Stripe
       @ephemeral_keys = Stripe::EphemeralKeyService.new(@requestor)
       @events = Stripe::EventService.new(@requestor)
       @exchange_rates = Stripe::ExchangeRateService.new(@requestor)
+      @external_accounts = Stripe::ExternalAccountService.new(@requestor)
       @files = Stripe::FileService.new(@requestor)
       @file_links = Stripe::FileLinkService.new(@requestor)
       @financial_connections = Stripe::FinancialConnectionsService.new(@requestor)
       @forwarding = Stripe::ForwardingService.new(@requestor)
+      @fx_quotes = Stripe::FxQuoteService.new(@requestor)
       @identity = Stripe::IdentityService.new(@requestor)
       @invoices = Stripe::InvoiceService.new(@requestor)
       @invoice_items = Stripe::InvoiceItemService.new(@requestor)
@@ -49,6 +53,8 @@ module Stripe
       @invoice_rendering_templates = Stripe::InvoiceRenderingTemplateService.new(@requestor)
       @issuing = Stripe::IssuingService.new(@requestor)
       @mandates = Stripe::MandateService.new(@requestor)
+      @margins = Stripe::MarginService.new(@requestor)
+      @orders = Stripe::OrderService.new(@requestor)
       @payment_attempt_records = Stripe::PaymentAttemptRecordService.new(@requestor)
       @payment_intents = Stripe::PaymentIntentService.new(@requestor)
       @payment_links = Stripe::PaymentLinkService.new(@requestor)
@@ -59,6 +65,7 @@ module Stripe
       @payouts = Stripe::PayoutService.new(@requestor)
       @plans = Stripe::PlanService.new(@requestor)
       @prices = Stripe::PriceService.new(@requestor)
+      @privacy = Stripe::PrivacyService.new(@requestor)
       @products = Stripe::ProductService.new(@requestor)
       @promotion_codes = Stripe::PromotionCodeService.new(@requestor)
       @quotes = Stripe::QuoteService.new(@requestor)

data/lib/stripe/services/v2/billing/bill_setting_service.rb

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class BillSettingService < StripeService
+        attr_reader :versions
+
+        def initialize(requestor)
+          super
+          @versions = Stripe::V2::Billing::BillSettings::VersionService.new(@requestor)
+        end
+
+        # Create a BillSetting object.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/bill_settings",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # List all BillSetting objects.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/billing/bill_settings",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve a BillSetting object by ID.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/billing/bill_settings/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Update fields on an existing BillSetting object.
+        def update(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/billing/bill_settings/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing/bill_settings/version_service.rb

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module BillSettings
+        class VersionService < StripeService
+          # List all BillSettingVersions by BillSetting ID.
+          def list(bill_setting_id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/bill_settings/%<bill_setting_id>s/versions", { bill_setting_id: CGI.escape(bill_setting_id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Retrieve a BillSettingVersion by ID.
+          def retrieve(bill_setting_id, id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/bill_settings/%<bill_setting_id>s/versions/%<id>s", { bill_setting_id: CGI.escape(bill_setting_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing/cadence_service.rb

@@ -0,0 +1,65 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class CadenceService < StripeService
+        # Cancel the Billing Cadence.
+        def cancel(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/billing/cadences/%<id>s/cancel", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Create a Billing Cadence object.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/cadences",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # List Billing Cadences.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/billing/cadences",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve a Billing Cadence object.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/billing/cadences/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Update a Billing Cadence object.
+        def update(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/billing/cadences/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end