Class: Increase::Resources::Documents

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Documents

Returns a new instance of Documents.



6
7
8
 
# File 'lib/increase/resources/documents.rb', line 6

def initialize(client:)
  @client = client
end

Instance Method Details

#list(params = {}, opts = {}) ⇒ Increase::Page<Increase::Models::Document>

List Documents

Parameters:

  • params (Hash) (defaults to: {}) —

    Attributes to send in this request.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :category (Category)
  • :created_at (CreatedAt)
  • :cursor (String) —

    Return the page of entries after this one.

  • :entity_id (String) —

    Filter Documents to ones belonging to the specified Entity.

  • :limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Returns:



37
38
39
40
41
42
43
44
45
 
# File 'lib/increase/resources/documents.rb', line 37

def list(params = {}, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/documents"
  req[:query] = params
  req[:page] = Increase::Page
  req[:model] = Increase::Models::Document
  @client.request(req, opts)
end

#retrieve(document_id, opts = {}) ⇒ Increase::Models::Document

Retrieve a Document

Parameters:

  • document_id (String) —

    The identifier of the Document to retrieve.

  • opts (Hash|RequestOptions) (defaults to: {}) —

    Options to specify HTTP behaviour for this request.

Returns:



16
17
18
19
20
21
22
 
# File 'lib/increase/resources/documents.rb', line 16

def retrieve(document_id, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/documents/#{document_id}"
  req[:model] = Increase::Models::Document
  @client.request(req, opts)
end