Class: Increase::Resources::Documents

Inherits:

Object

• Object
• Increase::Resources::Documents

Defined in:

lib/increase/resources/documents.rb

Instance Method Summary

• #create(category: , account_verification_letter: nil, funding_instructions: nil, request_options: {}) ⇒ Increase::Models::Document

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

• #initialize(client:) ⇒ Documents constructor private

  A new instance of Documents.

• #list(category: nil, created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::Document>

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

• #retrieve(document_id, request_options: {}) ⇒ Increase::Models::Document

  Retrieve a Document.

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:

• client (Increase::Client)

# File 'lib/increase/resources/documents.rb', line 94

def initialize(client:)
  @client = client
end

Instance Method Details

#create(category: , account_verification_letter: nil, funding_instructions: nil, request_options: {}) ⇒ Increase::Models::Document

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

Create a Document

Parameters:

• category (Symbol, Increase::Models::DocumentCreateParams::Category) —

  The type of document to create.

• account_verification_letter (Increase::Models::DocumentCreateParams::AccountVerificationLetter) —

  An account verification letter. Required if and only if ‘category` is `account_v

• funding_instructions (Increase::Models::DocumentCreateParams::FundingInstructions) —

  Funding instructions. Required if and only if ‘category` is `funding_instruction

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

Returns:

• (Increase::Models::Document)

See Also:

• Models::DocumentCreateParams

# File 'lib/increase/resources/documents.rb', line 24

def create(params)
  parsed, options = Increase::DocumentCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "documents",
    body: parsed,
    model: Increase::Document,
    options: options
  )
end

#list(category: nil, created_at: nil, cursor: nil, entity_id: nil, idempotency_key: nil, limit: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::Document>

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

List Documents

Parameters:

• category (Increase::Models::DocumentListParams::Category)
• created_at (Increase::Models::DocumentListParams::CreatedAt)
• cursor (String) —

  Return the page of entries after this one.

• entity_id (String) —

  Filter Documents to ones belonging to the specified Entity.

• idempotency_key (String) —

  Filter records to the one with the specified ‘idempotency_key` you chose for tha

• limit (Integer) —

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

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

Returns:

• (Increase::Internal::Page<Increase::Models::Document>)

See Also:

• Models::DocumentListParams

# File 'lib/increase/resources/documents.rb', line 79

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

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

Retrieve a Document

Parameters:

• document_id (String) —

  The identifier of the Document to retrieve.

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

Returns:

• (Increase::Models::Document)

See Also:

• Models::DocumentRetrieveParams

# File 'lib/increase/resources/documents.rb', line 46

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