stripe 5.55.0 → 13.5.1

data/lib/stripe/services/application_fee_refund_service.rb

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ApplicationFeeRefundService < StripeService
+    # Refunds an application fee that has previously been collected but not yet refunded.
+    # Funds will be refunded to the Stripe account from which the fee was originally collected.
+    #
+    # You can optionally refund only part of an application fee.
+    # You can do so multiple times, until the entire fee has been refunded.
+    #
+    # Once entirely refunded, an application fee can't be refunded again.
+    # This method will raise an error when called on an already-refunded application fee,
+    # or when trying to refund more money than is left on an application fee.
+    def create(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/application_fees/%<id>s/refunds", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.
+    def list(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/application_fees/%<id>s/refunds", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.
+    def retrieve(fee, id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/application_fees/%<fee>s/refunds/%<id>s", { fee: CGI.escape(fee), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    #
+    # This request only accepts metadata as an argument.
+    def update(fee, id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/application_fees/%<fee>s/refunds/%<id>s", { fee: CGI.escape(fee), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/application_fee_service.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ApplicationFeeService < StripeService
+    attr_reader :refunds
+
+    def initialize(requestor)
+      super(requestor)
+      @refunds = Stripe::ApplicationFeeRefundService.new(@requestor)
+    end
+
+    # Returns a list of application fees you've previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/application_fees",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/application_fees/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/apps/secret_service.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Apps
+    class SecretService < StripeService
+      # Create or replace a secret in the secret store.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/apps/secrets",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Deletes a secret from the secret store by name and scope.
+      def delete_where(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/apps/secrets/delete",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Finds a secret in the secret store by name and scope.
+      def find(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/apps/secrets/find",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # List all secrets stored on the given scope.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/apps/secrets",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/apps_service.rb

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

data/lib/stripe/services/balance_service.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class BalanceService < StripeService
+    # Retrieves the current account balance, based on the authentication that was used to make the request.
+    #  For a sample request, see [Accounting for negative balances](https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances).
+    def retrieve(params = {}, opts = {})
+      request(method: :get, path: "/v1/balance", params: params, opts: opts, base_address: :api)
+    end
+  end
+end

data/lib/stripe/services/balance_transaction_service.rb

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class BalanceTransactionService < StripeService
+    # Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
+    #
+    # Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/balance_transactions",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the balance transaction with the given ID.
+    #
+    # Note that this endpoint previously used the path /v1/balance/history/:id.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/balance_transactions/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/billing/alert_service.rb

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class AlertService < StripeService
+      # Reactivates this alert, allowing it to trigger again.
+      def activate(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/activate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Archives this alert, removing it from the list view and APIs. This is non-reversible.
+      def archive(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/archive", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a billing alert
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing/alerts",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Deactivates this alert, preventing it from triggering.
+      def deactivate(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/deactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Lists billing active and inactive alerts
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/alerts",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a billing alert given an ID
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/billing/alerts/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/credit_balance_summary_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditBalanceSummaryService < StripeService
+      # Retrieves the credit balance summary for a customer.
+      def retrieve(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/credit_balance_summary",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/credit_balance_transaction_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditBalanceTransactionService < StripeService
+      # Retrieve a list of credit balance transactions.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/credit_balance_transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a credit balance transaction.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/billing/credit_balance_transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/credit_grant_service.rb

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditGrantService < StripeService
+      # Creates a credit grant.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing/credit_grants",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Expires a credit grant.
+      def expire(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/expire", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve a list of credit grants.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/credit_grants",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a credit grant.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/billing/credit_grants/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates a credit grant.
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Voids a credit grant.
+      def void_grant(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/meter_event_adjustment_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterEventAdjustmentService < StripeService
+      # Creates a billing meter event adjustment.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing/meter_event_adjustments",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/meter_event_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterEventService < StripeService
+      # Creates a billing meter event.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing/meter_events",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/meter_event_summary_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterEventSummaryService < StripeService
+      # Retrieve a list of billing meter event summaries.
+      def list(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/billing/meters/%<id>s/event_summaries", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/meter_service.rb

@@ -0,0 +1,81 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterService < StripeService
+      attr_reader :event_summaries
+
+      def initialize(requestor)
+        super(requestor)
+        @event_summaries = Stripe::Billing::MeterEventSummaryService.new(@requestor)
+      end
+
+      # Creates a billing meter.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing/meters",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
+      def deactivate(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/deactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve a list of billing meters.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/meters",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
+      def reactivate(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s/reactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a billing meter given an ID.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/billing/meters/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates a billing meter.
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/meters/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing_portal/configuration_service.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module BillingPortal
+    class ConfigurationService < StripeService
+      # Creates a configuration that describes the functionality and behavior of a PortalSession
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing_portal/configurations",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of configurations that describe the functionality of the customer portal.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing_portal/configurations",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a configuration that describes the functionality of the customer portal.
+      def retrieve(configuration, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/billing_portal/configurations/%<configuration>s", { configuration: CGI.escape(configuration) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates a configuration that describes the functionality of the customer portal.
+      def update(configuration, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing_portal/configurations/%<configuration>s", { configuration: CGI.escape(configuration) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing_portal/session_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module BillingPortal
+    class SessionService < StripeService
+      # Creates a session of the customer portal.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing_portal/sessions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing_portal_service.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class BillingPortalService < StripeService
+    attr_reader :configurations, :sessions
+
+    def initialize(requestor)
+      super(requestor)
+      @configurations = Stripe::BillingPortal::ConfigurationService.new(@requestor)
+      @sessions = Stripe::BillingPortal::SessionService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/billing_service.rb

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class BillingService < StripeService
+    attr_reader :alerts, :credit_balance_summary, :credit_balance_transactions, :credit_grants, :meters, :meter_events, :meter_event_adjustments
+
+    def initialize(requestor)
+      super(requestor)
+      @alerts = Stripe::Billing::AlertService.new(@requestor)
+      @credit_balance_summary = Stripe::Billing::CreditBalanceSummaryService.new(@requestor)
+      @credit_balance_transactions = Stripe::Billing::CreditBalanceTransactionService
+                                     .new(@requestor)
+      @credit_grants = Stripe::Billing::CreditGrantService.new(@requestor)
+      @meters = Stripe::Billing::MeterService.new(@requestor)
+      @meter_events = Stripe::Billing::MeterEventService.new(@requestor)
+      @meter_event_adjustments = Stripe::Billing::MeterEventAdjustmentService.new(@requestor)
+    end
+  end
+end