Increase.SupplementalDocuments (Increase v1.0.0)

Functions for working with SupplementalDocuments via the Increase API.

See https://increase.com/documentation/api/supplemental-documents for the full API reference for this resource.

Summary

Functions

create(client, params \\ %{}, opts \\ [])

Create a supplemental document for an Entity

list(client, params \\ %{}, opts \\ [])

List Entity Supplemental Document Submissions

Functions

create(client, params \\ %{}, opts \\ [])

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.SupplementalDocuments.EntitySupplementalDocument.t()}
  | {:error, Increase.Error.t()}

Create a supplemental document for an Entity

POST /entity_supplemental_documents

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Entity Supplemental Document Submissions

Returns a %Increase.Page{} whose data is a list of %__MODULE__. EntitySupplementalDocument{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /entity_supplemental_documents