Increase.PhysicalCardProfiles (Increase v1.0.0)

Copy Markdown View Source

This contains artwork and metadata relating to a Physical Card's appearance. For more information, see our guide on physical card artwork.

See https://increase.com/documentation/api/physical-card-profiles for the full API reference for this resource.

Summary

Functions

archive(client, physical_card_profile_id, opts \\ [])

Archive a Physical Card Profile

clone(client, physical_card_profile_id, params \\ %{}, opts \\ [])

Clone a Physical Card Profile

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

Create a Physical Card Profile

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

List Physical Card Profiles

retrieve(client, physical_card_profile_id, opts \\ [])

Retrieve a Card Profile

Functions

archive(client, physical_card_profile_id, opts \\ [])

@spec archive(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.PhysicalCardProfiles.PhysicalCardProfile.t()}
  | {:error, Increase.Error.t()}

Archive a Physical Card Profile

POST /physical_card_profiles/{physical_card_profile_id}/archive

clone(client, physical_card_profile_id, params \\ %{}, opts \\ [])

@spec clone(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.PhysicalCardProfiles.PhysicalCardProfile.t()}
  | {:error, Increase.Error.t()}

Clone a Physical Card Profile

POST /physical_card_profiles/{physical_card_profile_id}/clone

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

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.PhysicalCardProfiles.PhysicalCardProfile.t()}
  | {:error, Increase.Error.t()}

Create a Physical Card Profile

POST /physical_card_profiles

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

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Physical Card Profiles

Returns a %Increase.Page{} whose data is a list of %__MODULE__. PhysicalCardProfile{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /physical_card_profiles

retrieve(client, physical_card_profile_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.PhysicalCardProfiles.PhysicalCardProfile.t()}
  | {:error, Increase.Error.t()}

Retrieve a Card Profile

GET /physical_card_profiles/{physical_card_profile_id}