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: ActivateParams, CarrierText, CreateParams, DeactivateParams, ListParams, Preferences, RejectParams, RejectionReasons, RetrieveParams, TestHelpers, UpdateParams

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

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



312
313
314
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 312

def 
  @card_logo
end

#carrier_text ⇒ Object (readonly)

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



315
316
317
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 315

def carrier_text
  @carrier_text
end

#created ⇒ Object (readonly)

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



318
319
320
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 318

def created
  @created
end

#id ⇒ Object (readonly)

Unique identifier for the object.



321
322
323
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 321

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.



324
325
326
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 324

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.



327
328
329
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 327

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.



330
331
332
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 330

def metadata
  @metadata
end

#name ⇒ Object (readonly)

Friendly display name.



333
334
335
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 333

def name
  @name
end

#object ⇒ Object (readonly)

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



336
337
338
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 336

def object
  @object
end

#physical_bundle ⇒ Object (readonly)

The physical bundle object belonging to this personalization design.



339
340
341
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 339

def physical_bundle
  @physical_bundle
end

#preferences ⇒ Object (readonly)

Attribute for field preferences



342
343
344
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 342

def preferences
  @preferences
end

#rejection_reasons ⇒ Object (readonly)

Attribute for field rejection_reasons



345
346
347
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 345

def rejection_reasons
  @rejection_reasons
end

#status ⇒ Object (readonly)

Whether this personalization design can be used to create cards.



348
349
350
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 348

def status
  @status
end

Class Method Details

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

Creates a personalization design object.



351
352
353
354
355
356
357
358
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 351

def self.create(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/issuing/personalization_designs",
    params: params,
    opts: opts
  )
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.



361
362
363
364
365
366
367
368
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 361

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(id, params = {}, opts = {}) ⇒ Object

Updates a card personalization object.



371
372
373
374
375
376
377
378
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 371

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

Instance Method Details

#test_helpers ⇒ Object 



380
381
382
 
# File 'lib/stripe/resources/issuing/personalization_design.rb', line 380

def test_helpers
  TestHelpers.new(self)
end