Class: Increase::Resources::InboundMailItems

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/inbound_mail_items.rb,
sig/increase/resources/inbound_mail_items.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ InboundMailItems

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of InboundMailItems.



93
94
95
 
# File 'lib/increase/resources/inbound_mail_items.rb', line 93

def initialize(client:)
  @client = client
end

Instance Method Details

#action(inbound_mail_item_id, checks:, request_options: {}) ⇒ Increase::Models::InboundMailItem

Deposits or ignores each check contained in a pending Inbound Mail Item. Depositing a check creates a Check Deposit into the Account you specify.

See Also:



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/increase/resources/inbound_mail_items.rb', line 79

def action(inbound_mail_item_id, params)
  parsed, options = Increase::InboundMailItemActionParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["inbound_mail_items/%1$s/action", inbound_mail_item_id],
    body: parsed,
    model: Increase::InboundMailItem,
    options: options
  )
end

#list(created_at: nil, cursor: nil, limit: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::InboundMailItem>

List Inbound Mail Items

See Also:



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/increase/resources/inbound_mail_items.rb', line 50

def list(params = {})
  parsed, options = Increase::InboundMailItemListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "inbound_mail_items",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::InboundMailItem,
    options: options
  )
end

#retrieve(inbound_mail_item_id, request_options: {}) ⇒ Increase::Models::InboundMailItem

Retrieve an Inbound Mail Item

See Also:



17
18
19
20
21
22
23
24
 
# File 'lib/increase/resources/inbound_mail_items.rb', line 17

def retrieve(inbound_mail_item_id, params = {})
  @client.request(
    method: :get,
    path: ["inbound_mail_items/%1$s", inbound_mail_item_id],
    model: Increase::InboundMailItem,
    options: params[:request_options]
  )
end