Sha256: d284788f9b23ee5bfa73a3bb1d06e60c530bc71ddce18804a08a064d1b90551b

Contents?: true

Size: 1.97 KB

Versions: 20

Compression:

Stored size: 1.97 KB

Contents

# 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

Version data entries

20 entries across 20 versions & 1 rubygems

Version Path
stripe-13.5.0 lib/stripe/services/billing/alert_service.rb
stripe-13.4.1 lib/stripe/services/billing/alert_service.rb
stripe-13.4.0 lib/stripe/services/billing/alert_service.rb
stripe-13.3.1 lib/stripe/services/billing/alert_service.rb
stripe-13.3.0 lib/stripe/services/billing/alert_service.rb
stripe-13.3.0.pre.beta.3 lib/stripe/services/billing/alert_service.rb
stripe-13.3.0.pre.beta.2 lib/stripe/services/billing/alert_service.rb
stripe-13.3.0.pre.beta.1 lib/stripe/services/billing/alert_service.rb
stripe-13.2.0 lib/stripe/services/billing/alert_service.rb
stripe-13.1.2 lib/stripe/services/billing/alert_service.rb
stripe-13.2.0.pre.beta.3 lib/stripe/services/billing/alert_service.rb
stripe-13.2.0.pre.beta.2 lib/stripe/services/billing/alert_service.rb
stripe-13.1.1 lib/stripe/services/billing/alert_service.rb
stripe-13.2.0.pre.beta.1 lib/stripe/services/billing/alert_service.rb
stripe-13.1.0 lib/stripe/services/billing/alert_service.rb
stripe-13.0.2 lib/stripe/services/billing/alert_service.rb
stripe-13.1.0.pre.beta.3 lib/stripe/services/billing/alert_service.rb
stripe-13.0.1 lib/stripe/services/billing/alert_service.rb
stripe-13.1.0.pre.beta.2 lib/stripe/services/billing/alert_service.rb
stripe-13.0.0 lib/stripe/services/billing/alert_service.rb