Inttegro.FileReferences (inttegro v0.2.0)

Reconciles references between files and the resources that use them.

References prevent backing objects from being removed while another resource still depends on them. Reconciliation is an administrative operation for repairing or verifying that ownership graph; it is not required for ordinary file downloads.

Summary

Functions

reconcile(client, request, options \\ [])

Replaces the complete set of live file references for one Inttegro resource. Omitting references or sending an empty array clears the set.

Functions

reconcile(client, request, options \\ [])

@spec reconcile(
  Inttegro.Client.t(),
  Inttegro.FileReferences.ReconcileRequest.t(),
  keyword()
) :: {:ok, Inttegro.FileReferences.Reconciliation.t()} | {:error, Exception.t()}

Replaces the complete set of live file references for one Inttegro resource. Omitting references or sending an empty array clears the set.

Parameters

client — an authenticated Inttegro.Client.
request — a Inttegro.FileReferences.ReconcileRequest containing the operation input.
options — request options such as :idempotency_key and additional :headers.

Returns

Returns {:ok, Inttegro.FileReferences.Reconciliation.t()} when Inttegro accepts and decodes the operation. Returns {:error, exception} for API, transport, or decoding failures. A successful API response can still describe an asynchronous resource that has not reached its terminal state.

Example

request = Inttegro.FileReferences.ReconcileRequest.new!(request_attributes)

case Inttegro.FileReferences.reconcile(client, request) do
  {:ok, result} -> result
  {:error, error} -> {:error, error}
end