Class: Stripe::Issuing::PersonalizationDesign

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

Overview

A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.

Defined Under Namespace

Classes: CarrierText, Preferences, RejectionReasons, TestHelpers

Constant Summary collapse

OBJECT_NAME = 
"issuing.personalization_design"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance 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

#==, #[], #[]=, #_get_inner_class_type, 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

Instance Attribute Details

#card_logo ⇒ Object (readonly)

The file for the card logo to use with physical bundles that support card logos. Must have a ‘purpose` value of `issuing_logo`.



66
67
68
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 66

def 
  @card_logo
end

#carrier_text ⇒ Object (readonly)

Hash containing carrier text, for use with physical bundles that support carrier text.



68
69
70
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 68

def carrier_text
  @carrier_text
end

#created ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



70
71
72
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 70

def created
  @created
end

#id ⇒ Object (readonly)

Unique identifier for the object.



72
73
74
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 72

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



74
75
76
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 74

def livemode
  @livemode
end

#lookup_key ⇒ Object (readonly)

A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.



76
77
78
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 76

def lookup_key
  @lookup_key
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



78
79
80
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 78

def metadata
  @metadata
end

#name ⇒ Object (readonly)

Friendly display name.



80
81
82
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 80

def name
  @name
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



82
83
84
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 82

def object
  @object
end

#physical_bundle ⇒ Object (readonly)

The physical bundle object belonging to this personalization design.



84
85
86
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 84

def physical_bundle
  @physical_bundle
end

#preferences ⇒ Object (readonly)

Attribute for field preferences



86
87
88
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 86

def preferences
  @preferences
end

#rejection_reasons ⇒ Object (readonly)

Attribute for field rejection_reasons



88
89
90
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 88

def rejection_reasons
  @rejection_reasons
end

#status ⇒ Object (readonly)

Whether this personalization design can be used to create cards.



90
91
92
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 90

def status
  @status
end

Class Method Details

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

Creates a personalization design object.



93
94
95
96
97
98
99
100
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 93

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

.field_remappings ⇒ Object 



201
202
203
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 201

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



193
194
195
196
197
198
199
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 193

def self.inner_class_types
  @inner_class_types = {
    carrier_text: CarrierText,
    preferences: Preferences,
    rejection_reasons: RejectionReasons,
  }
end

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

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.



103
104
105
106
107
108
109
110
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 103

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

.object_name ⇒ Object 



13
14
15
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 13

def self.object_name
  "issuing.personalization_design"
end

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

Updates a card personalization object.



113
114
115
116
117
118
119
120
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 113

def self.update(personalization_design, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/personalization_designs/%<personalization_design>s", { personalization_design: CGI.escape(personalization_design) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#test_helpers ⇒ Object 



122
123
124
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 122

def test_helpers
  TestHelpers.new(self)
end