Class: Stripe::GiftCards::Card

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/gift_cards/card.rb

Overview

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.

Constant Summary collapse

OBJECT_NAME = 
"gift_cards.card"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates a new gift card object.



19
20
21
22
23
24
25
26
 
# File 'lib/stripe/resources/gift_cards/card.rb', line 19

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/gift_cards/cards",
    params: params,
    opts: opts
  )
end

.list(filters = {}, opts = {}) ⇒ Object

List gift cards for an account



29
30
31
32
33
34
35
36
 
# File 'lib/stripe/resources/gift_cards/card.rb', line 29

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

.object_name ⇒ Object 



14
15
16
 
# File 'lib/stripe/resources/gift_cards/card.rb', line 14

def self.object_name
  "gift_cards.card"
end

.update(id, params = {}, opts = {}) ⇒ Object

Update a gift card



39
40
41
42
43
44
45
46
 
# File 'lib/stripe/resources/gift_cards/card.rb', line 39

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

.validate(params = {}, opts = {}) ⇒ Object

Validates a gift card code, returning the matching gift card object if it exists.



49
50
51
52
53
54
55
56
 
# File 'lib/stripe/resources/gift_cards/card.rb', line 49

def self.validate(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/gift_cards/cards/validate",
    params: params,
    opts: opts
  )
end