Contents

# frozen_string_literal: true

module Stripe
  module APIOperations
    module Delete
      module ClassMethods
        # Deletes an API resource
        #
        # Deletes the identified resource with the passed in parameters.
        #
        # ==== Attributes
        #
        # * +id+ - ID of the resource to delete.
        # * +params+ - A hash of parameters to pass to the API
        # * +opts+ - A Hash of additional options (separate from the params /
        #   object values) to be added to the request. E.g. to allow for an
        #   idempotency_key to be passed in the request headers, or for the
        #   api_key to be overwritten. See {APIOperations::Request.request}.
        def delete(id, params = {}, opts = {})
          opts = Util.normalize_opts(opts)
          resp, opts = request(:delete, "#{resource_url}/#{id}", params, opts)
          Util.convert_to_stripe_object(resp.data, opts)
        end
      end

      def delete(params = {}, opts = {})
        opts = Util.normalize_opts(opts)
        resp, opts = request(:delete, resource_url, params, opts)
        initialize_from(resp.data, opts)
      end

      def self.included(base)
        base.extend(ClassMethods)
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
stripe-4.16.0	lib/stripe/api_operations/delete.rb
stripe-4.15.0	lib/stripe/api_operations/delete.rb
stripe-4.14.0	lib/stripe/api_operations/delete.rb
stripe-4.13.0	lib/stripe/api_operations/delete.rb
stripe-4.12.0	lib/stripe/api_operations/delete.rb