Increase.OAuthConnections (Increase v1.0.0)

Copy Markdown View Source

When a user authorizes your OAuth application, an OAuth Connection object is created. Learn more about OAuth here.

See https://increase.com/documentation/api/oauth-connections for the full API reference for this resource.

Summary

Functions

list(client, params \\ %{}, opts \\ [])

List OAuth Connections

retrieve(client, oauth_connection_id, opts \\ [])

Retrieve an OAuth Connection

Functions

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List OAuth Connections

Returns a %Increase.Page{} whose data is a list of %__MODULE__. OAuthConnection{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /oauth_connections

retrieve(client, oauth_connection_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.OAuthConnections.OAuthConnection.t()}
  | {:error, Increase.Error.t()}

Retrieve an OAuth Connection

GET /oauth_connections/{oauth_connection_id}