Sha256: 5c26f6e437ef54f5c8d544039c7f2fa88810821b248eadb1ba38adab9552ac29

Contents?: true

Size: 1.95 KB

Versions: 49

Compression:

Stored size: 1.95 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  module Radar
    # Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
    #
    # Related guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)
    class ValueListItem < APIResource
      extend Stripe::APIOperations::Create
      include Stripe::APIOperations::Delete
      extend Stripe::APIOperations::List

      OBJECT_NAME = "radar.value_list_item"
      def self.object_name
        "radar.value_list_item"
      end

      # Creates a new ValueListItem object, which is added to the specified parent value list.
      def self.create(params = {}, opts = {})
        request_stripe_object(
          method: :post,
          path: "/v1/radar/value_list_items",
          params: params,
          opts: opts
        )
      end

      # Deletes a ValueListItem object, removing it from its parent value list.
      def self.delete(id, params = {}, opts = {})
        request_stripe_object(
          method: :delete,
          path: format("/v1/radar/value_list_items/%<id>s", { id: CGI.escape(id) }),
          params: params,
          opts: opts
        )
      end

      # Deletes a ValueListItem object, removing it from its parent value list.
      def delete(params = {}, opts = {})
        request_stripe_object(
          method: :delete,
          path: format("/v1/radar/value_list_items/%<item>s", { item: CGI.escape(self["id"]) }),
          params: params,
          opts: opts
        )
      end

      # Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
      def self.list(filters = {}, opts = {})
        request_stripe_object(
          method: :get,
          path: "/v1/radar/value_list_items",
          params: filters,
          opts: opts
        )
      end
    end
  end
end

Version data entries

49 entries across 49 versions & 1 rubygems

Version Path
stripe-13.3.0.pre.beta.1 lib/stripe/resources/radar/value_list_item.rb
stripe-13.2.0 lib/stripe/resources/radar/value_list_item.rb
stripe-13.1.2 lib/stripe/resources/radar/value_list_item.rb
stripe-13.2.0.pre.beta.3 lib/stripe/resources/radar/value_list_item.rb
stripe-13.2.0.pre.beta.2 lib/stripe/resources/radar/value_list_item.rb
stripe-13.1.1 lib/stripe/resources/radar/value_list_item.rb
stripe-13.2.0.pre.beta.1 lib/stripe/resources/radar/value_list_item.rb
stripe-13.1.0 lib/stripe/resources/radar/value_list_item.rb
stripe-13.0.2 lib/stripe/resources/radar/value_list_item.rb
stripe-13.1.0.pre.beta.3 lib/stripe/resources/radar/value_list_item.rb
stripe-13.0.1 lib/stripe/resources/radar/value_list_item.rb
stripe-13.1.0.pre.beta.2 lib/stripe/resources/radar/value_list_item.rb
stripe-13.0.0 lib/stripe/resources/radar/value_list_item.rb
stripe-12.7.0.pre.beta.2 lib/stripe/resources/radar/value_list_item.rb
stripe-12.7.0.pre.beta.1 lib/stripe/resources/radar/value_list_item.rb
stripe-12.6.0 lib/stripe/resources/radar/value_list_item.rb
stripe-12.6.0.pre.beta.1 lib/stripe/resources/radar/value_list_item.rb
stripe-12.5.0 lib/stripe/resources/radar/value_list_item.rb
stripe-12.5.0.pre.beta.2 lib/stripe/resources/radar/value_list_item.rb
stripe-12.5.0.pre.beta.1 lib/stripe/resources/radar/value_list_item.rb