stripe 12.7.0.pre.beta.2 → 13.1.0.pre.beta.2

data/lib/stripe/services/sigma/scheduled_query_run_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Sigma
+    class ScheduledQueryRunService < StripeService
+      # Returns a list of scheduled query runs.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/sigma/scheduled_query_runs",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of an scheduled query run.
+      def retrieve(scheduled_query_run, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/sigma/scheduled_query_runs/%<scheduled_query_run>s", { scheduled_query_run: CGI.escape(scheduled_query_run) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/sigma_service.rb

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

data/lib/stripe/services/source_service.rb

@@ -0,0 +1,64 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SourceService < StripeService
+    attr_reader :transactions
+
+    def initialize(requestor)
+      super(requestor)
+      @transactions = Stripe::SourceTransactionService.new(@requestor)
+    end
+
+    # Creates a new source object.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/sources", params: params, opts: opts, base_address: :api)
+    end
+
+    # Delete a specified source for a given customer.
+    def detach(customer, id, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/sources/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.
+    def retrieve(source, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/sources/%<source>s", { source: CGI.escape(source) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    #
+    # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://stripe.com/docs/sources) for more detail.
+    def update(source, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/sources/%<source>s", { source: CGI.escape(source) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Verify a given source.
+    def verify(source, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/sources/%<source>s/verify", { source: CGI.escape(source) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/source_transaction_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SourceTransactionService < StripeService
+    # List source transactions for a given source.
+    def list(source, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/sources/%<source>s/source_transactions", { source: CGI.escape(source) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/subscription_item_service.rb

@@ -0,0 +1,69 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SubscriptionItemService < StripeService
+    attr_reader :usage_records, :usage_record_summaries
+
+    def initialize(requestor)
+      super(requestor)
+      @usage_records = Stripe::SubscriptionItemUsageRecordService.new(@requestor)
+      @usage_record_summaries = Stripe::SubscriptionItemUsageRecordSummaryService.new(@requestor)
+    end
+
+    # Adds a new item to an existing subscription. No existing items will be changed or replaced.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/subscription_items",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
+    def delete(item, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/subscription_items/%<item>s", { item: CGI.escape(item) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of your subscription items for a given subscription.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/subscription_items",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the subscription item with the given ID.
+    def retrieve(item, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/subscription_items/%<item>s", { item: CGI.escape(item) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the plan or quantity of an item on a current subscription.
+    def update(item, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/subscription_items/%<item>s", { item: CGI.escape(item) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/subscription_item_usage_record_service.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SubscriptionItemUsageRecordService < StripeService
+    # Creates a usage record for a specified subscription item and date, and fills it with a quantity.
+    #
+    # Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the [metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing) plan, Stripe helps you send accurate invoices to your customers.
+    #
+    # The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan's aggregate_usage [parameter](https://stripe.com/docs/api/plans/create#create_plan-aggregate_usage). When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.
+    #
+    # The default pricing model for metered billing is [per-unit pricing. For finer granularity, you can configure metered billing to have a <a href="https://stripe.com/docs/billing/subscriptions/tiers">tiered pricing](https://stripe.com/docs/api/plans/object#plan_object-billing_scheme) model.
+    def create(subscription_item, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/subscription_items/%<subscription_item>s/usage_records", { subscription_item: CGI.escape(subscription_item) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/subscription_item_usage_record_summary_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SubscriptionItemUsageRecordSummaryService < StripeService
+    # For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that's been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).
+    #
+    # The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn't ended yet. Since new usage records can still be added, the returned summary information for the subscription item's ID should be seen as unstable until the subscription billing period ends.
+    def list(subscription_item, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/subscription_items/%<subscription_item>s/usage_record_summaries", { subscription_item: CGI.escape(subscription_item) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/subscription_schedule_service.rb

@@ -0,0 +1,83 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+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(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/cancel", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/subscription_schedules",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the list of your subscription schedules.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/subscription_schedules",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
+    def release(schedule, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/release", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.
+    def retrieve(schedule, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/subscription_schedules/%<schedule>s", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an existing subscription schedule.
+    def update(schedule, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/subscription_service.rb

@@ -0,0 +1,127 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SubscriptionService < StripeService
+    # 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://stripe.com/metadata).
+    #
+    # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/docs/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.
+    #
+    # By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
+    def cancel(subscription_exposed_id, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
+    #
+    # When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
+    # The payment_behavior parameter determines the exact behavior of the initial payment.
+    #
+    # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead.
+    # Schedules provide the flexibility to model more complex billing configurations that change over time.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/subscriptions",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Removes the currently applied discount on a subscription.
+    def delete_discount(subscription_exposed_id, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s/discount", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/subscriptions",
+        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(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/resume", { subscription: CGI.escape(subscription) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the subscription with the given ID.
+    def retrieve(subscription_exposed_id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Search for subscriptions you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+    # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+    # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+    # to an hour behind during outages. Search functionality is not available to merchants in India.
+    def search(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/subscriptions/search",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an existing subscription to match the specified parameters.
+    # When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
+    # To preview how the proration is calculated, use the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint.
+    #
+    # By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
+    #
+    # Switching prices does not normally change the billing date or generate an immediate charge unless:
+    #
+    #
+    # The billing interval is changed (for example, from monthly to yearly).
+    # The subscription moves from free to paid.
+    # A trial starts or ends.
+    #
+    #
+    # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://stripe.com/billing/subscriptions/upgrade-downgrade#immediate-payment).
+    #
+    # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create).
+    #
+    # If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
+    #
+    # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing](https://stripe.com/docs/rate-limits) instead.
+    def update(subscription_exposed_id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class CalculationLineItemService < StripeService
+      # Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.
+      def list(calculation, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(calculation) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class CalculationService < StripeService
+      attr_reader :line_items
+
+      def initialize(requestor)
+        super(requestor)
+        @line_items = Stripe::Tax::CalculationLineItemService.new(@requestor)
+      end
+
+      # Calculates tax based on the input and returns a Tax Calculation object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/tax/calculations",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a Tax Calculation object, if the calculation hasn't expired.
+      def retrieve(calculation, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/tax/calculations/%<calculation>s", { calculation: CGI.escape(calculation) }),
+          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/registration_service.rb

@@ -0,0 +1,54 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class RegistrationService < StripeService
+      # Creates a new Tax Registration object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/tax/registrations",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of Tax Registration objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/tax/registrations",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a Tax Registration object.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/tax/registrations/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates an existing Tax Registration object.
+      #
+      # A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/tax/registrations/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class SettingsService < StripeService
+      # Retrieves Tax Settings for a merchant.
+      def retrieve(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/tax/settings",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
+      def update(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/tax/settings",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class TransactionLineItemService < StripeService
+      # Retrieves the line items of a committed standalone transaction as a collection.
+      def list(transaction, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/tax/transactions/%<transaction>s/line_items", { transaction: CGI.escape(transaction) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end