Class: ModernTreasury::Resources::Transactions::LineItems

Inherits:
Object
  • Object
show all
Defined in:
lib/modern_treasury/resources/transactions/line_items.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ LineItems

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 LineItems.

Parameters:



105
106
107
 
# File 'lib/modern_treasury/resources/transactions/line_items.rb', line 105

def initialize(client:)
  @client = client
end

Instance Method Details

#create(amount: , expected_payment_id: , transaction_id: , request_options: {}) ⇒ ModernTreasury::Models::Transactions::TransactionLineItem

Some parameter documentations has been truncated, see Models::Transactions::LineItemCreateParams for more details.

create transaction line items

Parameters:

  • amount (Integer) —

    If a matching object exists in Modern Treasury, ‘amount` will be populated. Valu

  • expected_payment_id (String) —

    The ID of the reconciled Expected Payment, otherwise ‘null`.

  • transaction_id (String) —

    The ID of the parent transaction.

  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/modern_treasury/resources/transactions/line_items.rb', line 25

def create(params)
  parsed, options = ModernTreasury::Transactions::LineItemCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/transaction_line_items",
    body: parsed,
    model: ModernTreasury::Transactions::TransactionLineItem,
    options: options
  )
end

#delete(id, request_options: {}) ⇒ nil

delete transaction line item

Parameters:

Returns:

  • (nil)

See Also:



93
94
95
96
97
98
99
100
 
# File 'lib/modern_treasury/resources/transactions/line_items.rb', line 93

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["api/transaction_line_items/%1$s", id],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(id: nil, after_cursor: nil, per_page: nil, transaction_id: nil, type: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::Transactions::TransactionLineItem>

list transaction_line_items

Parameters:

Returns:

See Also:



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/modern_treasury/resources/transactions/line_items.rb', line 70

def list(params = {})
  parsed, options = ModernTreasury::Transactions::LineItemListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "api/transaction_line_items",
    query: parsed,
    page: ModernTreasury::Internal::Page,
    model: ModernTreasury::Transactions::TransactionLineItem,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::Transactions::TransactionLineItem

get transaction line item

Parameters:

Returns:

See Also:



47
48
49
50
51
52
53
54
 
# File 'lib/modern_treasury/resources/transactions/line_items.rb', line 47

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["api/transaction_line_items/%1$s", id],
    model: ModernTreasury::Transactions::TransactionLineItem,
    options: params[:request_options]
  )
end