ArchAstro.SDK.V1.Tasks.Links (archastro v0.3.1)

Copy Markdown

Link API resource.

Summary

Functions

create(client, task, input)

Add an external link to a task

remove(client, task)

Remove an external link from a task

Functions

create(client, task, input)

@spec create(
  ArchAstro.SDK.Client.t(),
  String.t(),
  ArchAstro.SDK.Types.Operations.PostApiV1TasksTaskLinks.Input.t()
) ::
  {:ok, %{optional(String.t()) => ArchAstro.SDK.JSON.t()}}
  | {:error, ArchAstro.SDK.Error.reason()}

Add an external link to a task

The created external link.

remove(client, task)

@spec remove(ArchAstro.SDK.Client.t(), String.t()) ::
  {:ok, :ok} | {:error, ArchAstro.SDK.Error.reason()}

Remove an external link from a task

HTTP 204 on success.