Class: ModernTreasury::Resources::Documents

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Documents

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

Parameters:



90
91
92
 
# File 'lib/modern_treasury/resources/documents.rb', line 90

def initialize(client:)
  @client = client
end

Instance Method Details

#create(documentable_id: , documentable_type: , file: , document_type: nil, request_options: {}) ⇒ ModernTreasury::Models::Document

Create a document.

Parameters:

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/modern_treasury/resources/documents.rb', line 23

def create(params)
  parsed, options = ModernTreasury::DocumentCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/documents",
    headers: {"content-type" => "multipart/form-data"},
    body: parsed,
    model: ModernTreasury::Document,
    options: options
  )
end

#list(after_cursor: nil, documentable_id: nil, documentable_type: nil, per_page: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::Document>

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

Get a list of documents.

Parameters:

Returns:

See Also:



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/modern_treasury/resources/documents.rb', line 75

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

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

Get an existing document.

Parameters:

Returns:

See Also:



46
47
48
49
50
51
52
53
 
# File 'lib/modern_treasury/resources/documents.rb', line 46

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