OpenCode.Generated.Connectors (opencode_sdk v0.1.88)

@type v2_connector_connect_oauth_begin_200_json_resp() :: %{
  data: OpenCode.Generated.ConnectorAttempt.t(),
  location: OpenCode.Generated.LocationInfo.t()
}

v2_connector_connect_oauth_status_200_json_resp()

@type v2_connector_connect_oauth_status_200_json_resp() :: %{
  data: v2_connector_connect_oauth_status_200_json_resp_data(),
  location: OpenCode.Generated.LocationInfo.t()
}

v2_connector_connect_oauth_status_200_json_resp_data()

@type v2_connector_connect_oauth_status_200_json_resp_data() :: %{
  message: String.t(),
  status: String.t(),
  time: v2_connector_connect_oauth_status_200_json_resp_data_time()
}

v2_connector_connect_oauth_status_200_json_resp_data_time()

@type v2_connector_connect_oauth_status_200_json_resp_data_time() :: %{
  created: number() | String.t(),
  expires: number() | String.t()
}

v2_connector_get_200_json_resp()

@type v2_connector_get_200_json_resp() :: %{
  data: OpenCode.Generated.ConnectorInfo.t(),
  location: OpenCode.Generated.LocationInfo.t()
}

v2_connector_list_200_json_resp()

@type v2_connector_list_200_json_resp() :: %{
  data: [OpenCode.Generated.ConnectorInfo.t()],
  location: OpenCode.Generated.LocationInfo.t()
}

Functions

v2_connector_connect_key(connectorID, body, opts \\ [])

@spec v2_connector_connect_key(
  connectorID :: String.t(),
  body :: map(),
  opts :: keyword()
) ::
  :ok
  | {:error,
     OpenCode.Generated.InvalidRequestError.t()
     | OpenCode.Generated.UnauthorizedError.t()}

Connect with key

Run a key authentication method and store the resulting credential.

Options

location

Request Body

Content Types: application/json

v2_connector_connect_oauth_begin(connectorID, body, opts \\ [])

@spec v2_connector_connect_oauth_begin(
  connectorID :: String.t(),
  body :: map(),
  opts :: keyword()
) ::
  {:ok, v2_connector_connect_oauth_begin_200_json_resp()}
  | {:error,
     OpenCode.Generated.InvalidRequestError.t()
     | OpenCode.Generated.UnauthorizedError.t()}

Begin OAuth connection

Start an OAuth attempt and return the authorization details.

Options

location

Request Body

Content Types: application/json

v2_connector_connect_oauth_cancel(attemptID, opts \\ [])

@spec v2_connector_connect_oauth_cancel(attemptID :: String.t(), opts :: keyword()) ::
  :ok
  | {:error,
     OpenCode.Generated.InvalidRequestError.t()
     | OpenCode.Generated.UnauthorizedError.t()}

Cancel OAuth connection

Cancel an OAuth attempt and release its resources.

Options

location

v2_connector_connect_oauth_complete(attemptID, body, opts \\ [])

@spec v2_connector_connect_oauth_complete(
  attemptID :: String.t(),
  body :: map(),
  opts :: keyword()
) ::
  :ok
  | {:error,
     OpenCode.Generated.InvalidRequestError.t()
     | OpenCode.Generated.UnauthorizedError.t()}

Complete OAuth connection

Complete a code-based OAuth attempt and store the resulting credential.

Options

location

Request Body

Content Types: application/json

v2_connector_connect_oauth_status(attemptID, opts \\ [])

@spec v2_connector_connect_oauth_status(attemptID :: String.t(), opts :: keyword()) ::
  {:ok, v2_connector_connect_oauth_status_200_json_resp()}
  | {:error,
     OpenCode.Generated.InvalidRequestError.t()
     | OpenCode.Generated.UnauthorizedError.t()}

Get OAuth attempt status

Poll the current status of an OAuth attempt.

Options

location

v2_connector_get(connectorID, opts \\ [])

@spec v2_connector_get(connectorID :: String.t(), opts :: keyword()) ::
  {:ok, v2_connector_get_200_json_resp()}
  | {:error,
     OpenCode.Generated.InvalidRequestError.t()
     | OpenCode.Generated.UnauthorizedError.t()}

Get connector

Retrieve one connector and its authentication methods.

Options

location

v2_connector_list(opts \\ [])

@spec v2_connector_list(opts :: keyword()) ::
  {:ok, v2_connector_list_200_json_resp()}
  | {:error,
     OpenCode.Generated.InvalidRequestError.t()
     | OpenCode.Generated.UnauthorizedError.t()}

List connectors

Retrieve available connectors and their authentication methods.

Options

location