Class: ModernTreasury::Resources::JournalReports

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ JournalReports

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

Parameters:



73
74
75
 
# File 'lib/modern_treasury/resources/journal_reports.rb', line 73

def initialize(client:)
  @client = client
end

Instance Method Details

#list(request_options: {}) ⇒ nil

Retrieve a list of journal reports

Parameters:

Returns:

  • (nil)

See Also:



61
62
63
64
65
66
67
68
 
# File 'lib/modern_treasury/resources/journal_reports.rb', line 61

def list(params = {})
  @client.request(
    method: :get,
    path: "api/journal_reports",
    model: NilClass,
    options: params[:request_options]
  )
end

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

Retrieve a specific journal report

Parameters:

Returns:

  • (nil)

See Also:



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

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

#update(id, metadata: nil, status: nil, request_options: {}) ⇒ nil

Update a journal report

Parameters:

  • id (String) —

    The ID of the journal report

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

Returns:

  • (nil)

See Also:



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/modern_treasury/resources/journal_reports.rb', line 41

def update(id, params = {})
  parsed, options = ModernTreasury::JournalReportUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["api/journal_reports/%1$s", id],
    body: parsed,
    model: NilClass,
    options: options
  )
end