stripe 12.7.0.pre.beta.2 → 13.0.0

data/lib/stripe/services/radar/value_list_service.rb

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Radar
+    class ValueListService < StripeService
+      # Creates a new ValueList object, which can then be referenced in rules.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/radar/value_lists",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
+      def delete(value_list, params = {}, opts = {})
+        request(
+          method: :delete,
+          path: format("/v1/radar/value_lists/%<value_list>s", { value_list: CGI.escape(value_list) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of ValueList 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/radar/value_lists",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a ValueList object.
+      def retrieve(value_list, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/radar/value_lists/%<value_list>s", { value_list: CGI.escape(value_list) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
+      def update(value_list, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/radar/value_lists/%<value_list>s", { value_list: CGI.escape(value_list) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/radar_service.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class RadarService < StripeService
+    attr_reader :early_fraud_warnings, :value_lists, :value_list_items
+
+    def initialize(requestor)
+      super(requestor)
+      @early_fraud_warnings = Stripe::Radar::EarlyFraudWarningService.new(@requestor)
+      @value_lists = Stripe::Radar::ValueListService.new(@requestor)
+      @value_list_items = Stripe::Radar::ValueListItemService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/refund_service.rb

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class RefundService < StripeService
+    # Cancels a refund with a status of requires_action.
+    #
+    # You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
+    def cancel(refund, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/refunds/%<refund>s/cancel", { refund: CGI.escape(refund) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
+    #
+    # Creating a new refund will refund a charge that has previously been created but not yet refunded.
+    # Funds will be refunded to the credit or debit card that was originally charged.
+    #
+    # You can optionally refund only part of a charge.
+    # You can do so multiple times, until the entire charge has been refunded.
+    #
+    # Once entirely refunded, a charge can't be refunded again.
+    # This method will raise an error when called on an already-refunded charge,
+    # or when trying to refund more money than is left on a charge.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/refunds", params: params, opts: opts, base_address: :api)
+    end
+
+    # Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/refunds", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the details of an existing refund.
+    def retrieve(refund, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/refunds/%<refund>s", { refund: CGI.escape(refund) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged.
+    #
+    # This request only accepts metadata as an argument.
+    def update(refund, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/refunds/%<refund>s", { refund: CGI.escape(refund) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/reporting/report_run_service.rb

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Reporting
+    class ReportRunService < StripeService
+      # Creates a new object and begin running the report. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/reporting/report_runs",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of Report Runs, with the most recent appearing first.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/reporting/report_runs",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of an existing Report Run.
+      def retrieve(report_run, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/reporting/report_runs/%<report_run>s", { report_run: CGI.escape(report_run) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/reporting/report_type_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Reporting
+    class ReportTypeService < StripeService
+      # Returns a full list of Report Types.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/reporting/report_types",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Report Type. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
+      def retrieve(report_type, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/reporting/report_types/%<report_type>s", { report_type: CGI.escape(report_type) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/reporting_service.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ReportingService < StripeService
+    attr_reader :report_runs, :report_types
+
+    def initialize(requestor)
+      super(requestor)
+      @report_runs = Stripe::Reporting::ReportRunService.new(@requestor)
+      @report_types = Stripe::Reporting::ReportTypeService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/review_service.rb

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ReviewService < StripeService
+    # Approves a Review object, closing it and removing it from the list of reviews.
+    def approve(review, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/reviews/%<review>s/approve", { review: CGI.escape(review) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of Review objects that have open set to true. 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/reviews", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves a Review object.
+    def retrieve(review, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/reviews/%<review>s", { review: CGI.escape(review) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/setup_attempt_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SetupAttemptService < StripeService
+    # Returns a list of SetupAttempts that associate with a provided SetupIntent.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/setup_attempts",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/setup_intent_service.rb

@@ -0,0 +1,105 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SetupIntentService < StripeService
+    # You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
+    #
+    # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.
+    def cancel(intent, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/setup_intents/%<intent>s/cancel", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Confirm that your customer intends to set up the current or
+    # provided payment method. For example, you would confirm a SetupIntent
+    # when a customer hits the “Save” button on a payment method management
+    # page on your website.
+    #
+    # If the selected payment method does not require any additional
+    # steps from the customer, the SetupIntent will transition to the
+    # succeeded status.
+    #
+    # Otherwise, it will transition to the requires_action status and
+    # suggest additional actions via next_action. If setup fails,
+    # the SetupIntent will transition to the
+    # requires_payment_method status or the canceled status if the
+    # confirmation limit is reached.
+    def confirm(intent, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/setup_intents/%<intent>s/confirm", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Creates a SetupIntent object.
+    #
+    # After you create the SetupIntent, attach a payment method and [confirm](https://stripe.com/docs/api/setup_intents/confirm)
+    # it to collect any required permissions to charge the payment method later.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/setup_intents",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of SetupIntents.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/setup_intents",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the details of a SetupIntent that has previously been created.
+    #
+    # Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.
+    #
+    # When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the [SetupIntent](https://stripe.com/docs/api#setup_intent_object) object reference for more details.
+    def retrieve(intent, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/setup_intents/%<intent>s", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates a SetupIntent object.
+    def update(intent, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/setup_intents/%<intent>s", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Verifies microdeposits on a SetupIntent object.
+    def verify_microdeposits(intent, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/setup_intents/%<intent>s/verify_microdeposits", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/shipping_rate_service.rb

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ShippingRateService < StripeService
+    # Creates a new shipping rate object.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/shipping_rates",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of your shipping rates.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/shipping_rates",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns the shipping rate object with the given ID.
+    def retrieve(shipping_rate_token, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/shipping_rates/%<shipping_rate_token>s", { shipping_rate_token: CGI.escape(shipping_rate_token) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an existing shipping rate object.
+    def update(shipping_rate_token, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/shipping_rates/%<shipping_rate_token>s", { shipping_rate_token: CGI.escape(shipping_rate_token) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

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