Tink.ReportJobs (Tink v1.0.0)

Copy Markdown View Source

Async report generation job status polling. Requires reports-generation-jobs:readonly scope.

Summary

Functions

Get a report generation job by ID.

Poll a report generation job until ready or timed out.

Functions

get(client, job_id)

@spec get(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

Get a report generation job by ID.

poll_until_complete(client, job_id, opts \\ [])

@spec poll_until_complete(Tink.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Tink.Error.t() | :timeout}

Poll a report generation job until ready or timed out.

Options

  • :timeout_ms — default 60_000
  • :interval_ms — default 2_000