Sha256: c8a33b2f2e2d556bb3e21350a4aab6fa75856b7fc04fe9f121cfe6f3f330d47a

Contents?: true

Size: 1.59 KB

Versions: 20

Compression:

Stored size: 1.59 KB

Contents

# File generated from our OpenAPI spec
# frozen_string_literal: true

module Stripe
  module GiftCards
    # A gift card represents a single gift card owned by a customer, including the
    # remaining balance, gift card code, and whether or not it is active.
    class Card < APIResource
      extend Stripe::APIOperations::Create
      extend Stripe::APIOperations::List
      include Stripe::APIOperations::Save

      OBJECT_NAME = "gift_cards.card"
      def self.object_name
        "gift_cards.card"
      end

      # Creates a new gift card object.
      def self.create(params = {}, opts = {})
        request_stripe_object(
          method: :post,
          path: "/v1/gift_cards/cards",
          params: params,
          opts: opts
        )
      end

      # List gift cards for an account
      def self.list(filters = {}, opts = {})
        request_stripe_object(
          method: :get,
          path: "/v1/gift_cards/cards",
          params: filters,
          opts: opts
        )
      end

      # Update a gift card
      def self.update(id, params = {}, opts = {})
        request_stripe_object(
          method: :post,
          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
          params: params,
          opts: opts
        )
      end

      # Validates a gift card code, returning the matching gift card object if it exists.
      def self.validate(params = {}, opts = {})
        request_stripe_object(
          method: :post,
          path: "/v1/gift_cards/cards/validate",
          params: params,
          opts: opts
        )
      end
    end
  end
end

Version data entries

20 entries across 20 versions & 1 rubygems

Version Path
stripe-13.3.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-13.2.0.pre.beta.3 lib/stripe/resources/gift_cards/card.rb
stripe-13.2.0.pre.beta.2 lib/stripe/resources/gift_cards/card.rb
stripe-13.2.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-13.1.0.pre.beta.3 lib/stripe/resources/gift_cards/card.rb
stripe-13.1.0.pre.beta.2 lib/stripe/resources/gift_cards/card.rb
stripe-12.7.0.pre.beta.2 lib/stripe/resources/gift_cards/card.rb
stripe-12.7.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-12.6.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-12.5.0.pre.beta.2 lib/stripe/resources/gift_cards/card.rb
stripe-12.5.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-12.2.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-11.7.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-11.4.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-11.3.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-11.1.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-10.15.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-10.14.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-10.13.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb
stripe-10.12.0.pre.beta.1 lib/stripe/resources/gift_cards/card.rb