View Source Plaid.AssetReport (plaid v3.2.0)

Functions for Plaid asset report endpoint.

Link to this section Summary

Functions

Gets the Asset Report from Plaid.

Link to this section Types

@type config() :: %{required(atom()) => String.t() | keyword()}
@type error() :: {:error, Plaid.Error.t() | any()} | no_return()
@type params() :: %{required(atom()) => term()}
@type t() :: %Plaid.AssetReport{
  asset_report_id: String.t(),
  client_report_id: String.t(),
  date_generated: String.t(),
  days_requested: integer(),
  items: [Plaid.AssetReport.Item.t()],
  user: Plaid.AssetReport.User.t(),
  warnings: [Plaid.AssetReport.Warning.t()]
}

Link to this section Functions

Link to this function

create_asset_report(params, config \\ %{})

View Source
@spec create_asset_report(params(), config()) :: {:ok, map()} | error()

Creates an asset report.

Parameters

%{
  access_tokens: ["access-env-identifier"],
  days_requested: 356
}

Response

{:ok,
  %{asset_report_token: "assets-sandbox-6f12f5bb-22dd-4855-b918-f47ec439198a",
    asset_report_id: "1f414183-220c-44f5-b0c8-bc0e6d4053bb"",
    request_id: "Iam3b"
  }
}
Link to this function

get(params, config \\ %{})

View Source
@spec get(params(), config()) :: {:ok, t()} | error()

Gets the Asset Report from Plaid.

Parameters

%{
  asset_report_token: "assets-sandbox-6f12f5bb-22dd-4855-b918-f47ec439198a"
}