Increase.OAuthApplications (Increase v1.0.0)

Copy Markdown View Source

An OAuth Application lets you build an application for others to use with their Increase data. You can create an OAuth Application via the Dashboard and read information about it with the API. Learn more about OAuth here.

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

Summary

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 Applications

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

GET /oauth_applications

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

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

Retrieve an OAuth Application

GET /oauth_applications/{oauth_application_id}