View Source Stripe.Issuing.PersonalizationDesign (stripity_stripe v3.3.1)

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

Summary

Types

carrier_text()

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

preferences()

rejection_reasons()

The reason(s) the personalization design was rejected.

t()

The issuing.personalization_design type.

Functions

activate(personalization_design, params \\ %{}, opts \\ [])

Updates the status of the specified testmode personalization design object to active.

create(params \\ %{}, opts \\ [])

Creates a personalization design object.

deactivate(personalization_design, params \\ %{}, opts \\ [])

Updates the status of the specified testmode personalization design object to inactive.

list(params \\ %{}, opts \\ [])

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.

reject(personalization_design, params \\ %{}, opts \\ [])

Updates the status of the specified testmode personalization design object to rejected.

retrieve(personalization_design, params \\ %{}, opts \\ [])

Retrieves a personalization design object.

update(personalization_design, params \\ %{}, opts \\ [])

Updates a card personalization object.

Types

carrier_text()

@type carrier_text() :: %{
  optional(:footer_body) => binary() | binary(),
  optional(:footer_title) => binary() | binary(),
  optional(:header_body) => binary() | binary(),
  optional(:header_title) => binary() | binary()
}

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

preferences()

@type preferences() :: %{
  optional(:is_default) => boolean(),
  optional(:is_platform_default) => boolean()
}

rejection_reasons()

@type rejection_reasons() :: %{
  optional(:card_logo) => [
    :geographic_location
    | :inappropriate
    | :network_name
    | :non_binary_image
    | :non_fiat_currency
    | :other
    | :other_entity
    | :promotional_material
  ],
  optional(:carrier_text) => [
    :geographic_location
    | :inappropriate
    | :network_name
    | :non_fiat_currency
    | :other
    | :other_entity
    | :promotional_material
  ]
}

The reason(s) the personalization design was rejected.

t()

@type t() :: %Stripe.Issuing.PersonalizationDesign{
  card_logo: (binary() | Stripe.File.t()) | nil,
  carrier_text: term() | nil,
  created: integer(),
  id: binary(),
  livemode: boolean(),
  lookup_key: binary() | nil,
  metadata: term(),
  name: binary() | nil,
  object: binary(),
  physical_bundle: binary() | Stripe.Issuing.PhysicalBundle.t(),
  preferences: term(),
  rejection_reasons: term(),
  status: binary()
}

The issuing.personalization_design type.

card_logo The file for the card logo to use with physical bundles that support card logos. Must have a purpose value of issuing_logo.
carrier_text Hash containing carrier text, for use with physical bundles that support carrier text.
created Time at which the object was created. Measured in seconds since the Unix epoch.
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
lookup_key A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
name Friendly display name.
object String representing the object's type. Objects of the same type share the same value.
physical_bundle The physical bundle object belonging to this personalization design.
preferences
rejection_reasons
status Whether this personalization design can be used to create cards.

Functions

activate(personalization_design, params \\ %{}, opts \\ [])

@spec activate(
  personalization_design :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates the status of the specified testmode personalization design object to active.

Details

Method: post
Path: /v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate

create(params \\ %{}, opts \\ [])

@spec create(
  params :: %{
    optional(:card_logo) => binary(),
    optional(:carrier_text) => carrier_text(),
    optional(:expand) => [binary()],
    optional(:lookup_key) => binary(),
    optional(:metadata) => %{optional(binary()) => binary()},
    optional(:name) => binary(),
    optional(:physical_bundle) => binary(),
    optional(:preferences) => preferences(),
    optional(:transfer_lookup_key) => boolean()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a personalization design object.

Details

Method: post
Path: /v1/issuing/personalization_designs

deactivate(personalization_design, params \\ %{}, opts \\ [])

@spec deactivate(
  personalization_design :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates the status of the specified testmode personalization design object to inactive.

Details

Method: post
Path: /v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate

list(params \\ %{}, opts \\ [])

@spec list(
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:lookup_keys) => [binary()],
    optional(:preferences) => preferences(),
    optional(:starting_after) => binary(),
    optional(:status) => :active | :inactive | :rejected | :review
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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.

Details

Method: get
Path: /v1/issuing/personalization_designs

reject(personalization_design, params \\ %{}, opts \\ [])

@spec reject(
  personalization_design :: binary(),
  params :: %{
    optional(:expand) => [binary()],
    optional(:rejection_reasons) => rejection_reasons()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates the status of the specified testmode personalization design object to rejected.

Details

Method: post
Path: /v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject

retrieve(personalization_design, params \\ %{}, opts \\ [])

@spec retrieve(
  personalization_design :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves a personalization design object.

Details

Method: get
Path: /v1/issuing/personalization_designs/{personalization_design}

update(personalization_design, params \\ %{}, opts \\ [])

@spec update(
  personalization_design :: binary(),
  params :: %{
    optional(:card_logo) => binary() | binary(),
    optional(:carrier_text) => carrier_text() | binary(),
    optional(:expand) => [binary()],
    optional(:lookup_key) => binary() | binary(),
    optional(:metadata) => %{optional(binary()) => binary()},
    optional(:name) => binary() | binary(),
    optional(:physical_bundle) => binary(),
    optional(:preferences) => preferences(),
    optional(:transfer_lookup_key) => boolean()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates a card personalization object.

Details

Method: post
Path: /v1/issuing/personalization_designs/{personalization_design}