Module: Unit::Card

Defined in:
lib/unit/models/card/card.rb,
lib/unit/models/card/list_card_params.rb,
lib/unit/models/card/replace_card_request.rb,
lib/unit/models/card/create_business_debit_card_request.rb,
lib/unit/models/card/create_individual_debit_card_request.rb,
lib/unit/models/card/create_individual_virtual_card_request.rb,
lib/unit/models/card/create_business_virtual_debit_card_request.rb

Defined Under Namespace

Classes: CreateBusinessDebitCardRequest, CreateBusinessVirtualDebitCardRequest, CreateIndividualDebitCardRequest, CreateIndividualVirtualCardRequest, ListCardParams, ReplaceCardRequest

Constant Summary collapse

CARD_LIST_LIMIT = 
100
CARD_LIST_OFFSET = 
0

Class Method Summary collapse

Class Method Details

.close_card(card_id:) ⇒ Object

Close a card by calling Unit’s API

Parameters:

  • card_id (String) 


97
98
99
 
# File 'lib/unit/models/card/card.rb', line 97

def close_card(card_id:)
  Unit::Resource::CardResource.close_card(card_id)
end

.create_business_debit_card(account_id:, full_name:, date_of_birth:, address:, phone:, email:, shipping_address: nil, design: nil, additional_embossed_text: nil, idempotency_key: nil, tags: nil, limits: nil, print_only_business_name: nil) ⇒ Object

Create a new business debit card by calling Unit’s API

Parameters:

  • full_name (FullName)
  • date_of_birth (Date)
  • address (Address)
  • shipping_address (Address) (defaults to: nil) —

    • optional

  • phone (Phone) —

    • optional

  • email (String) —

    • optional

  • design (String) (defaults to: nil) —

    • optional

  • additional_embossed_text (String) (defaults to: nil) —

    • optional

  • idempotency_key (String) (defaults to: nil) —

    • optional

  • tags (Hash) (defaults to: nil) —

    • optional

  • limits (Hash) (defaults to: nil) —

    • optional

  • print_only_business_name (Boolean) (defaults to: nil) —

    • optional

See Also:



46
47
48
49
50
51
 
# File 'lib/unit/models/card/card.rb', line 46

def create_business_debit_card(account_id:, full_name:, date_of_birth:, address:, phone:, email:, shipping_address: nil,
                               design: nil, additional_embossed_text: nil, idempotency_key: nil, tags: nil, limits: nil, print_only_business_name: nil)
  request = CreateBusinessDebitCardRequest.new(, full_name, date_of_birth, address, shipping_address, phone, email, design, additional_embossed_text,
                                               idempotency_key, tags, limits, print_only_business_name)
  Unit::Resource::CardResource.create_card(request)
end

.create_business_virtual_card(account_id:, full_name:, date_of_birth:, address:, phone: nil, email: nil, idempotency_key: nil, tags: nil, limits: nil) ⇒ Object

Create a new business virtual card by calling Unit’s API

Parameters:

  • account_id (String)
  • type (String)
  • idempotency_key (String) (defaults to: nil) —

    • optional

  • tags (Hash) (defaults to: nil) —

    • optional

  • limits (Hash) (defaults to: nil) —

    • optional

See Also:



71
72
73
74
 
# File 'lib/unit/models/card/card.rb', line 71

def create_business_virtual_card(account_id:, full_name:, date_of_birth:, address:, phone: nil, email: nil, idempotency_key: nil, tags: nil, limits: nil)
  request = CreateBusinessVirtualDebitCardRequest.new(, full_name, date_of_birth, address, phone, email, idempotency_key, tags, limits)
  Unit::Resource::CardResource.create_card(request)
end

.create_individual_debit_card(account_id:, customer_id: nil, shipping_address: nil, design: nil, additional_embossed_text: nil, idempotency_key: nil, tags: nil, limits: nil, print_only_business_name: nil) ⇒ Object

Create a new individual debit card by calling Unit’s API

Parameters:

  • account_id (String)
  • shipping_address (Address) (defaults to: nil) —

    • optional

  • design (String) (defaults to: nil) —

    • optional

  • additional_embossed_text (String) (defaults to: nil) —

    • optional

  • idempotency_key (String) (defaults to: nil) —

    • optional

  • tags (Hash) (defaults to: nil) —

    • optional

  • limits (Hash) (defaults to: nil) —

    • optional

  • print_only_business_name (String) (defaults to: nil) —

    • optional

See Also:



25
26
27
28
29
30
 
# File 'lib/unit/models/card/card.rb', line 25

def create_individual_debit_card(account_id:, customer_id: nil, shipping_address: nil, design: nil, additional_embossed_text: nil,
                                 idempotency_key: nil, tags: nil, limits: nil, print_only_business_name: nil)
  request = CreateIndividualDebitCardRequest.new(, customer_id, shipping_address, design, additional_embossed_text,
                                                 idempotency_key, tags, limits, print_only_business_name)
  Unit::Resource::CardResource.create_card(request)
end

.create_individual_virtual_card(account_id:, customer_id: nil, idempotency_key: nil, tags: nil, limits: nil) ⇒ Object

Create a new individual virtual card by calling Unit’s API

Parameters:

  • account_id (String)
  • idempotency_key (String) (defaults to: nil) —

    • optional

  • tags (Hash) (defaults to: nil) —

    • optional

  • limits (Hash) (defaults to: nil) —

    • optional

See Also:



59
60
61
62
 
# File 'lib/unit/models/card/card.rb', line 59

def create_individual_virtual_card(account_id:, customer_id: nil, idempotency_key: nil, tags: nil, limits: nil)
  request = CreateIndividualVirtualCardRequest.new(, customer_id, idempotency_key, tags, limits)
  Unit::Resource::CardResource.create_card(request)
end

.freeze_card(card_id:) ⇒ Object

Freeze a card by calling Unit’s API

Parameters:

  • card_id (String) 


103
104
105
 
# File 'lib/unit/models/card/card.rb', line 103

def freeze_card(card_id:)
  Unit::Resource::CardResource.freeze_card(card_id)
end

.get_card(card_id:) ⇒ Object

Get a card by id by calling Unit’s API

Parameters:

  • card_id (String) 


123
124
125
 
# File 'lib/unit/models/card/card.rb', line 123

def get_card(card_id:)
  Unit::Resource::CardResource.get_card(card_id)
end

.get_pin_status(card_id:) ⇒ Object

Get pin status by calling Unit’s API

Parameters:

  • card_id (String)

See Also:



79
80
81
 
# File 'lib/unit/models/card/card.rb', line 79

def get_pin_status(card_id:)
  Unit::Resource::CardResource.get_pin_status(card_id)
end

.limits(card_id:) ⇒ Object

Get a card limits by calling Unit’s API

Parameters:

  • card_id (String) 


144
145
146
 
# File 'lib/unit/models/card/card.rb', line 144

def limits(card_id:)
  Unit::Resource::CardResource.limits(card_id)
end

.list_cards(limit: CARD_LIST_LIMIT, offset: CARD_LIST_OFFSET, account_id: nil, customer_id: nil, tags: nil, status: nil, include: nil, sort: nil) ⇒ Object

List cards by calling Unit’s API

Parameters:

  • limit (Integer) (defaults to: CARD_LIST_LIMIT) —

    • optional

  • offset (Integer) (defaults to: CARD_LIST_OFFSET) —

    • optional

  • account_id (String) (defaults to: nil) —

    • optional

  • customer_id (String) (defaults to: nil) —

    • optional

  • tags (Hash) (defaults to: nil) —

    • optional

  • status (Array<String>) (defaults to: nil) —

    • optional

  • include (Array) (defaults to: nil) —

    • optional

  • sort (String) (defaults to: nil) —

    • optional



136
137
138
139
140
 
# File 'lib/unit/models/card/card.rb', line 136

def list_cards(limit: CARD_LIST_LIMIT, offset: CARD_LIST_OFFSET, account_id: nil,
               customer_id: nil, tags: nil, status: nil, include: nil, sort: nil)
  request = ListCardParams.new(limit, offset, , customer_id, tags, status, include, sort)
  Unit::Resource::CardResource.list_cards(request)
end

.replace_card(card_id:, shipping_address: nil) ⇒ Object

Replace a card by calling Unit’s API

Parameters:

  • card_id (String)
  • shipping_address (Address) (defaults to: nil) —

    • optional



116
117
118
119
 
# File 'lib/unit/models/card/card.rb', line 116

def replace_card(card_id:, shipping_address: nil)
  request = ReplaceCardRequest.new(card_id, shipping_address)
  Unit::Resource::CardResource.replace_card(request)
end

.report_lost(card_id:) ⇒ Object

Report a card as a lost by calling Unit’s API

Parameters:

  • card_id (String) 


91
92
93
 
# File 'lib/unit/models/card/card.rb', line 91

def report_lost(card_id:)
  Unit::Resource::CardResource.report_lost(card_id)
end

.report_stolen(card_id:) ⇒ Object

Report a card as a stolen by calling Unit’s API

Parameters:

  • card_id (String) 


85
86
87
 
# File 'lib/unit/models/card/card.rb', line 85

def report_stolen(card_id:)
  Unit::Resource::CardResource.report_stolen(card_id)
end

.unfreeze_card(card_id:) ⇒ Object

Unfreeze a card by calling Unit’s API

Parameters:

  • card_id (String) 


109
110
111
 
# File 'lib/unit/models/card/card.rb', line 109

def unfreeze_card(card_id:)
  Unit::Resource::CardResource.unfreeze_card(card_id)
end